findsofficepath.c

Go to the documentation of this file.

/* -*- 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 <sal/config.h>
 
#include <stdlib.h>
#include <string.h>
 
#include <cppuhelper/findsofficepath.h>
 
#if defined(_WIN32)
 
#define WIN32_LEAN_AND_MEAN
#include <windows.h>
 
/*
 * Gets the installation path from the Windows Registry for the specified
 * registry key.
 *
 * @param hroot       open handle to predefined root registry key
 * @param subKeyName  name of the subkey to open
 *
 * @return the installation path or NULL, if no installation was found or
 *         if an error occurred
 */
static wchar_t* getPathFromRegistryKey( HKEY hroot, const wchar_t* subKeyName )
{
    HKEY hkey;
    DWORD type;
    wchar_t* data = NULL;
    DWORD size;
 
    /* open the specified registry key */
    if ( RegOpenKeyExW( hroot, subKeyName, 0, KEY_READ, &hkey ) != ERROR_SUCCESS )
    {
        return NULL;
    }
 
    /* find the type and size of the default value */
    if ( RegQueryValueExW( hkey, NULL, NULL, &type, NULL, &size) != ERROR_SUCCESS )
    {
        RegCloseKey( hkey );
        return NULL;
    }
 
    /* get memory to hold the default value */
    data = (wchar_t*) malloc( size + sizeof(wchar_t) );
 
    /* read the default value */
    if ( RegQueryValueExW( hkey, NULL, NULL, &type, (LPBYTE) data, &size ) != ERROR_SUCCESS )
    {
        RegCloseKey( hkey );
        free( data );
        return NULL;
    }
 
    // According to https://msdn.microsoft.com/en-us/ms724911, If the data has the REG_SZ,
    // REG_MULTI_SZ or REG_EXPAND_SZ type, the string may not have been stored with the
    // proper terminating null characters
    data[size / sizeof(wchar_t)] = 0;
 
    /* release registry key handle */
    RegCloseKey( hkey );
 
    return data;
}
 
/*
 * Gets the installation path from the Windows Registry.
 *
 * @return the installation path or NULL, if no installation was found or
 *         if an error occurred
 */
static wchar_t* platformSpecific(void)
{
    const wchar_t* UNOPATHVARNAME = L"UNO_PATH";
 
    /* get the installation path from the UNO_PATH environment variable */
    wchar_t* env = _wgetenv(UNOPATHVARNAME);
 
    if (env && env[0])
    {
        return wcsdup(env);
    }
 
    const wchar_t* SUBKEYNAME = L"Software\\LibreOffice\\UNO\\InstallPath";
 
    /* read the key's default value from HKEY_CURRENT_USER */
    wchar_t* path = getPathFromRegistryKey( HKEY_CURRENT_USER, SUBKEYNAME );
 
    if ( path == NULL )
    {
        /* read the key's default value from HKEY_LOCAL_MACHINE */
        path = getPathFromRegistryKey( HKEY_LOCAL_MACHINE, SUBKEYNAME );
    }
 
    return path;
}
 
#else
 
#include <limits.h>
 
/*
 * Gets the installation path from the PATH environment variable.
 *
 * <p>An installation is found, if the executable 'soffice' or a symbolic link
 * is in one of the directories listed in the PATH environment variable.</p>
 *
 * @return the installation path or NULL, if no installation was found or
 *         if an error occurred
 */
static char* platformSpecific(void)
{
    const char* UNOPATHVARNAME = "UNO_PATH";
 
    /* get the installation path from the UNO_PATH environment variable */
    char* env = getenv(UNOPATHVARNAME);
 
    const int SEPARATOR = '/';
    const char* PATHSEPARATOR = ":";
    const char* PATHVARNAME = "PATH";
    const char* APPENDIX = "/libreoffice";
 
    char* path = NULL;
    char* str = NULL;
    char* dir = NULL;
    char* sep = NULL;
 
    char buffer[PATH_MAX];
    int pos;
 
    if (env && env[0])
    {
        return strdup(env);
    }
 
    /* get the value of the PATH environment variable */
    env = getenv( PATHVARNAME );
    if (env == NULL)
        return NULL;
 
    str = strdup( env );
    if (str == NULL)
        return NULL;
 
    /* get the tokens separated by ':' */
    dir = strtok( str, PATHSEPARATOR );
 
    while ( dir )
    {
        /* construct soffice file path */
        char* resolved = NULL;
        char* file = (char*) malloc( strlen( dir ) + strlen( APPENDIX ) + 1 );
        if (file == NULL)
        {
            free(str);
            return NULL;
        }
 
        strcpy( file, dir );
        strcat( file, APPENDIX );
 
        /* resolve symbolic link */
        resolved = realpath( file, buffer );
        if ( resolved != NULL )
        {
            /* get path to program directory */
            sep = strrchr( resolved, SEPARATOR );
 
            if ( sep != NULL )
            {
                pos = sep - resolved;
                path = (char*) malloc( pos + 1 );
                strncpy( path, resolved, pos );
                path[ pos ] = '\0';
                free( file );
                break;
            }
        }
 
        dir = strtok( NULL, PATHSEPARATOR );
        free( file );
    }
 
    free( str );
 
    return path;
}
 
#endif
 
#if defined(_WIN32)
wchar_t*
#else
char*
#endif
cppuhelper_detail_findSofficePath(void)
{
    return platformSpecific();
}
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */