1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen * IPRT - Symbolic Link Manipulation.
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen * Copyright (C) 2010-2011 Oracle Corporation
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen * This file is part of VirtualBox Open Source Edition (OSE), as
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen * available from http://www.virtualbox.org. This file is free software;
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen * you can redistribute it and/or modify it under the terms of the GNU
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen * General Public License (GPL) as published by the Free Software
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen * Foundation, in version 2 as it comes in the "COPYING" file of the
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen * The contents of this file may alternatively be used under the terms
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen * of the Common Development and Distribution License Version 1.0
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen * VirtualBox OSE distribution, in which case the provisions of the
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen * CDDL are applicable instead of those of the GPL.
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen * You may elect to license modified versions of this file under the
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen * terms and conditions of either the GPL or the CDDL or both.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek/** @defgroup grp_rt_symlink RTSymlink - Symbolic Link Manipulation
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @ingroup grp_rt
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * For querying and changing symlink info (mode, ownership, etc) please refer
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * to the @ref grp_rt_path "RTPath" API: RTPathQueryInfoEx, RTPathSetOwnerEx,
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * RTPathSetModeEx and RTPathSetTimesEx.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * Checks if the specified path exists and is a symlink.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @returns true if it's a symlink, false if it isn't.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @param pszSymlink The path to the symlink.
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen * @sa RTDirExists, RTPathExists, RTSymlinkExists.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-SzmekRTDECL(bool) RTSymlinkExists(const char *pszSymlink);
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * Checks if this is a dangling link or not.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * If the target of @a pszSymlink is a symbolic link, this may return false if
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * that or any subsequent links are dangling.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @returns true if it's dangling, false if it isn't.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @param pszSymlink The path to the symlink.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-SzmekRTDECL(bool) RTSymlinkIsDangling(const char *pszSymlink);
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * RTSymlinkCreate link type argument.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek /** Invalid value. */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek /** The link targets a directory. */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek /** The link targets a file (or whatever else). */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek /** It is not known what is being targeted.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @remarks The RTSymlinkCreate API may probe the target to try figure
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * out what is being targeted. */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek /** The end of the valid type values. */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek /** Blow the type up to 32-bit. */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek RTSYMLINKTYPE_32BIT_HACK = 0x7fffffff
102bd40e1ed71c7ab980a90435a1c23d4c786c63Lennart Poettering/** @name RTSymlinkCreate flags.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek/** Don't allow symbolic links as part of the path.
1ff28eaee33d9d0cee46bd176b6d6f8805c95036Tom Gundersen * @remarks this flag is currently not implemented and will be ignored. */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek#define RTSYMLINKCREATE_FLAGS_NO_SYMLINKS RT_BIT(0)
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * Creates a symbolic link (@a pszSymlink) targeting @a pszTarget.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @returns IPRT status code.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @param pszSymlink The name of the symbolic link.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @param pszTarget The path to the symbolic link target. This is
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * relative to @a pszSymlink or an absolute path.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @param enmType The symbolic link type. For Windows compatability
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * it is very important to set this correctly. When
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * RTSYMLINKTYPE_UNKNOWN is used, the API will try
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * make a guess and may attempt query information
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * about @a pszTarget in the process.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @param fCreate Create flags, RTSYMLINKCREATE_FLAGS_*.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-SzmekRTDECL(int) RTSymlinkCreate(const char *pszSymlink, const char *pszTarget,
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek RTSYMLINKTYPE enmType, uint32_t fCreate);
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek/** @name RTSymlinkDelete flags.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek/** Don't allow symbolic links as part of the path.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @remarks this flag is currently not implemented and will be ignored. */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek#define RTSYMLINKDELETE_FLAGS_NO_SYMLINKS RT_BIT(0)
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * Deletes the specified symbolic link.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * This will try to refuse deleting non-symlinks, however there are usually
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * races in the implementation of this check so no guarantees can be are made.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @returns IPRT status code.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @retval VERR_NOT_SYMLINK if @a pszSymlink does not specify a symbolic link.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @param pszSymlink The symbolic link that should be removed.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @param fDelete Delete flags, RTSYMLINKDELETE_FLAGS_*.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-SzmekRTDECL(int) RTSymlinkDelete(const char *pszSymlink, uint32_t fDelete);
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek/** @name RTSymlinkRead flags.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek/** Don't allow symbolic links as part of the path.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @remarks this flag is currently not implemented and will be ignored. */
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek#define RTSYMLINKREAD_FLAGS_NO_SYMLINKS RT_BIT(0)
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * Read the symlink target.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @returns IPRT status code.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @retval VERR_NOT_SYMLINK if @a pszSymlink does not specify a symbolic link.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @retval VERR_BUFFER_OVERFLOW if the link is larger than @a cbTarget. The
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * buffer will contain what all we managed to read, fully terminated
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * if @a cbTarget > 0.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @param pszSymlink The symbolic link that should be read.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @param pszTarget The target buffer.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @param cbTarget The size of the target buffer.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @param fRead Read flags, RTSYMLINKREAD_FLAGS_*.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-SzmekRTDECL(int) RTSymlinkRead(const char *pszSymlink, char *pszTarget, size_t cbTarget, uint32_t fRead);
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * Read the symlink target into an API allocated buffer.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * This API eliminates the race involved in determining the right buffer size.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @returns IPRT status code.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @retval VERR_NOT_SYMLINK if @a pszSymlink does not specify a symbolic link.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @param pszSymlink The symbolic link that should be read.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * @param ppszTarget Where to return the target string. Free the string
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek * by calling RTStrFree.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-SzmekRTDECL(int) RTSymlinkReadA(const char *pszSymlink, char **ppszTarget);