RTPathAppend.cpp revision b6cc4092c1e80655a5bc19dc125e772a8d2b870d
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync/* $Id$ */
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync/** @file
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * IPRT - RTPathAppend
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync */
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync/*
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * Copyright (C) 2009 Sun Microsystems, Inc.
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync *
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * available from http://www.virtualbox.org. This file is free software;
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * you can redistribute it and/or modify it under the terms of the GNU
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * General Public License (GPL) as published by the Free Software
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync *
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * The contents of this file may alternatively be used under the terms
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * of the Common Development and Distribution License Version 1.0
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * VirtualBox OSE distribution, in which case the provisions of the
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * CDDL are applicable instead of those of the GPL.
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync *
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * You may elect to license modified versions of this file under the
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * terms and conditions of either the GPL or the CDDL or both.
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync *
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * Clara, CA 95054 USA or visit http://www.sun.com if you need
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * additional information or have any questions.
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync */
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync/*******************************************************************************
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync* Header Files *
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync*******************************************************************************/
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync#include "internal/iprt.h"
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync#include <iprt/path.h>
b6cc4092c1e80655a5bc19dc125e772a8d2b870dvboxsync
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync#include <iprt/assert.h>
73faa4fdf1520bc23e5ee3ee044781c0aa11a6a0vboxsync#include <iprt/ctype.h>
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync#include <iprt/err.h>
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync#include <iprt/string.h>
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync/**
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * Figures the length of the root part of the path.
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync *
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * @returns length of the root specifier.
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * @retval 0 if none.
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync *
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * @param pszPath The path to investigate.
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync *
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * @remarks Unnecessary root slashes will not be counted. The caller will have
b6cc4092c1e80655a5bc19dc125e772a8d2b870dvboxsync * to deal with it where it matters. (Unlike rtPathRootSpecLen which
b6cc4092c1e80655a5bc19dc125e772a8d2b870dvboxsync * counts them.)
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync */
b6cc4092c1e80655a5bc19dc125e772a8d2b870dvboxsyncstatic size_t rtPathRootSpecLen2(const char *pszPath)
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync{
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync /* fend of wildlife. */
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync if (!pszPath)
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync return 0;
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync /* Root slash? */
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync if (RTPATH_IS_SLASH(pszPath[0]))
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync {
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync#if defined (RT_OS_OS2) || defined (RT_OS_WINDOWS)
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync /* UNC? */
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync if ( RTPATH_IS_SLASH(pszPath[1])
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync && pszPath[2] != '\0'
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync && !RTPATH_IS_SLASH(pszPath[2]))
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync {
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync /* Find the end of the server name. */
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync const char *pszEnd = pszPath + 2;
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync pszEnd += 2;
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync while ( *pszEnd != '\0'
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync && !RTPATH_IS_SLASH(*pszEnd))
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync pszEnd++;
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync if (RTPATH_IS_SLASH(*pszEnd))
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync {
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync pszEnd++;
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync while (RTPATH_IS_SLASH(*pszEnd))
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync pszEnd++;
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync /* Find the end of the share name */
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync while ( *pszEnd != '\0'
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync && !RTPATH_IS_SLASH(*pszEnd))
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync pszEnd++;
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync if (RTPATH_IS_SLASH(*pszEnd))
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync pszEnd++;
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync return pszPath - pszEnd;
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync }
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync }
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync#endif
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync return 1;
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync }
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync#if defined (RT_OS_OS2) || defined (RT_OS_WINDOWS)
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync /* Drive specifier? */
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync if ( pszPath[0] != '\0'
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync && pszPath[1] == ':'
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync && RT_C_IS_ALPHA(pszPath[0]))
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync {
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync if (RTPATH_IS_SLASH(pszPath[2]))
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync return 3;
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync return 2;
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync }
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync#endif
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync return 0;
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync}
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsyncRTDECL(int) RTPathAppend(char *pszPath, size_t cbPathDst, const char *pszAppend)
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync{
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync char *pszPathEnd = (char *)memchr(pszPath, '\0', cbPathDst);
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync AssertReturn(pszPathEnd, VERR_INVALID_PARAMETER);
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync /*
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * Special cases.
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync */
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync if (!pszAppend)
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync return VINF_SUCCESS;
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync size_t cchAppend = strlen(pszAppend);
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync if (!cchAppend)
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync return VINF_SUCCESS;
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync if (pszPathEnd == pszPath)
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync {
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync if (cchAppend >= cbPathDst)
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync return VERR_BUFFER_OVERFLOW;
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync memcpy(pszPath, pszAppend, cchAppend + 1);
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync return VINF_SUCCESS;
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync }
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync /*
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * Balance slashes and check for buffer overflow.
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync */
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync bool fAddSlash = false;
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync if (!RTPATH_IS_SLASH(pszPathEnd[-1]))
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync {
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync if (!RTPATH_IS_SLASH(pszAppend[0]))
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync {
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync#if defined (RT_OS_OS2) || defined (RT_OS_WINDOWS)
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync if ( (size_t)(pszPathEnd - pszPath) == 2
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync && pszPath[1] == ':'
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync && RT_C_IS_ALPHA(pszPath[0]))
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync {
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync if ((size_t)(pszPathEnd - pszPath) + cchAppend >= cbPathDst)
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync return VERR_BUFFER_OVERFLOW;
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync }
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync else
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync#endif
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync {
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync if ((size_t)(pszPathEnd - pszPath) + 1 + cchAppend >= cbPathDst)
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync return VERR_BUFFER_OVERFLOW;
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync *pszPathEnd++ = '/';
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync }
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync }
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync else
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync {
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync /* One slash is sufficient at this point. */
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync while (RTPATH_IS_SLASH(pszAppend[1]))
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync pszAppend++, cchAppend--;
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync if ((size_t)(pszPathEnd - pszPath) + cchAppend >= cbPathDst)
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync return VERR_BUFFER_OVERFLOW;
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync }
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync }
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync else
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync {
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync /* No slashes needed in the appended bit. */
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync while (RTPATH_IS_SLASH(*pszAppend))
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync pszAppend++, cchAppend--;
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync /* In the leading path we can skip unnecessary trailing slashes, but
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync be sure to leave one. */
b6cc4092c1e80655a5bc19dc125e772a8d2b870dvboxsync size_t const cchRoot = rtPathRootSpecLen2(pszPath);
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync while ( (size_t)(pszPathEnd - pszPath) > RT_MAX(1, cchRoot)
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync && RTPATH_IS_SLASH(pszPathEnd[-2]))
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync pszPathEnd--;
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync if ((size_t)(pszPathEnd - pszPath) + cchAppend >= cbPathDst)
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync return VERR_BUFFER_OVERFLOW;
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync }
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync /*
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync * What remains now is the just the copying.
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync */
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync memcpy(pszPathEnd, pszAppend, cchAppend + 1);
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync return VINF_SUCCESS;
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync}
fe02cc356f7bd01a7ffbcd6ceb8ca09bb1c35330vboxsync