sal/osl/unx/file_volume.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   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  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #include <sal/config.h>
  21
  22 #include <osl/file.h>
  23
  24 #include <osl/diagnose.h>
  25 #include <osl/thread.h>
  26 #include <rtl/alloc.h>
  27
  28 #include "file_error_transl.hxx"
  29 #include "file_url.hxx"
  30 #include "system.hxx"
  31
  32 #include <errno.h>
  33 #include <limits.h>
  34 #include <stdio.h>
  35 #include <string.h>
  36 #include <unistd.h>
  37 #include <sys/wait.h>
  38 #include <sal/macros.h>
  39
  40 #ifdef HAVE_STATFS_H
  41 #undef HAVE_STATFS_H
  42 #endif
  43
  44 #if defined(LINUX) && defined(__FreeBSD_kernel__)
  45 #undef LINUX
  46 #define FREEBSD 1
  47 #endif
  48
  49 #if defined(__sun)
  50
  51 #include <sys/mnttab.h>
  52 #include <sys/statvfs.h>
  53 #define  HAVE_STATFS_H
  54
  55 #elif defined(LINUX)
  56
  57 #include <mntent.h>
  58 #include <sys/vfs.h>
  59 #define  HAVE_STATFS_H
  60
  61 #elif defined(NETBSD) || defined(FREEBSD) || defined(OPENBSD) || defined(DRAGONFLY)
  62
  63 #include <sys/param.h>
  64 #include <sys/ucred.h>
  65 #include <sys/mount.h>
  66 #define  HAVE_STATFS_H
  67
  68 #elif defined(MACOSX)
  69
  70 #include <sys/param.h>
  71 #include <sys/mount.h>
  72 #define HAVE_STATFS_H
  73
  74 #endif /* HAVE_STATFS_H */
  75
  76 /************************************************************************
  77  *   ToDo
  78  *
  79  *   - Fix: check for corresponding struct sizes in exported functions
  80  *   - check size/use of oslVolumeInfo
  81  ***********************************************************************/
  82
  83 /******************************************************************************
  84  *
  85  *                  C-String Function Declarations
  86  *
  87  *****************************************************************************/
  88
  89 static oslFileError osl_psz_getVolumeInformation(const char* , oslVolumeInfo* pInfo, sal_uInt32 uFieldMask);
  90
  91 /****************************************************************************/
  92 /*  osl_getVolumeInformation */
  93 /****************************************************************************/
  94
  95 oslFileError osl_getVolumeInformation( rtl_uString* ustrDirectoryURL, oslVolumeInfo* pInfo, sal_uInt32 uFieldMask )
  96 {
  97     char path[PATH_MAX];
  98     oslFileError eRet;
  99
 100     OSL_ASSERT( ustrDirectoryURL );
 101     OSL_ASSERT( pInfo );
 102
 103     /* convert directory url to system path */
 104     eRet = FileURLToPath( path, PATH_MAX, ustrDirectoryURL );
 105     if( eRet != osl_File_E_None )
 106         return eRet;
 107
 108 #ifdef MACOSX
 109     if ( macxp_resolveAlias( path, PATH_MAX ) != 0 )
 110       return oslTranslateFileError( errno );
 111 #endif/* MACOSX */
 112
 113     return osl_psz_getVolumeInformation( path, pInfo, uFieldMask);
 114 }
 115
 116 /******************************************************************************
 117  *
 118  *                  C-String Versions of Exported Module Functions
 119  *
 120  *****************************************************************************/
 121
 122 #ifdef HAVE_STATFS_H
 123
 124 #if defined(FREEBSD) || defined(MACOSX) || defined(OPENBSD) || defined(DRAGONFLY)
 125 #   define OSL_detail_STATFS_STRUCT                  struct statfs
 126 #   define OSL_detail_STATFS(dir, sfs)               statfs((dir), (sfs))
 127 #   define OSL_detail_STATFS_BLKSIZ(a)               (static_cast<sal_uInt64>((a).f_bsize))
 128 #   define OSL_detail_STATFS_TYPENAME(a)             ((a).f_fstypename)
 129 #if defined(OPENBSD)
 130 #   define OSL_detail_STATFS_ISREMOTE(a)             (rtl_str_compare((a).f_fstypename, "nfs") == 0)
 131 #else
 132 #   define OSL_detail_STATFS_ISREMOTE(a)             (((a).f_type & MNT_LOCAL) == 0)
 133 #endif
 134
 135 /* always return true if queried for the properties of
 136    the file system. If you think this is wrong under any
 137    of the target platforms fix it!!!! */
 138 #   define OSL_detail_STATFS_IS_CASE_SENSITIVE_FS(a)  (true)
 139 #   define OSL_detail_STATFS_IS_CASE_PRESERVING_FS(a) (true)
 140 #endif /* FREEBSD || MACOSX || OPENBSD */
 141
 142 #if defined(NETBSD)
 143
 144 #   define OSL_detail_STATFS_STRUCT              struct statvfs
 145 #   define OSL_detail_STATFS(dir, sfs)           statvfs((dir), (sfs))
 146 #   define OSL_detail_STATFS_ISREMOTE(a)         (((a).f_flag & ST_LOCAL) == 0)
 147
 148 #   define OSL_detail_STATFS_BLKSIZ(a)           ((sal_uInt64)((a).f_bsize))
 149 #   define OSL_detail_STATFS_TYPENAME(a)         ((a).f_fstypename)
 150
 151 #   define OSL_detail_STATFS_IS_CASE_SENSITIVE_FS(a) (strcmp((a).f_fstypename, "msdos") != 0 && strcmp((a).f_fstypename, "ntfs") != 0 && strcmp((a).f_fstypename, "smbfs") != 0)
 152 #   define OSL_detail_STATFS_IS_CASE_PRESERVING_FS(a)    (strcmp((a).f_fstypename, "msdos") != 0)
 153 #endif /* NETBSD */
 154
 155 #if defined(LINUX)
 156 #   define OSL_detail_NFS_SUPER_MAGIC                 0x6969
 157 #   define OSL_detail_SMB_SUPER_MAGIC                 0x517B
 158 #   define OSL_detail_MSDOS_SUPER_MAGIC               0x4d44
 159 #   define OSL_detail_NTFS_SUPER_MAGIC                0x5346544e
 160 #   define OSL_detail_STATFS_STRUCT                   struct statfs
 161 #   define OSL_detail_STATFS(dir, sfs)                statfs((dir), (sfs))
 162 #   define OSL_detail_STATFS_BLKSIZ(a)                (static_cast<sal_uInt64>((a).f_bsize))
 163 #   define OSL_detail_STATFS_IS_NFS(a)                (OSL_detail_NFS_SUPER_MAGIC == (a).f_type)
 164 #   define OSL_detail_STATFS_IS_SMB(a)                (OSL_detail_SMB_SUPER_MAGIC == (a).f_type)
 165 #   define OSL_detail_STATFS_ISREMOTE(a)              (OSL_detail_STATFS_IS_NFS((a)) || OSL_detail_STATFS_IS_SMB((a)))
 166 #   define OSL_detail_STATFS_IS_CASE_SENSITIVE_FS(a)  ((OSL_detail_MSDOS_SUPER_MAGIC != (a).f_type) && (OSL_detail_NTFS_SUPER_MAGIC != (a).f_type))
 167 #   define OSL_detail_STATFS_IS_CASE_PRESERVING_FS(a) ((OSL_detail_MSDOS_SUPER_MAGIC != (a).f_type))
 168 #endif /* LINUX */
 169
 170 #if defined(__sun)
 171 #   define OSL_detail_STATFS_STRUCT                   struct statvfs
 172 #   define OSL_detail_STATFS(dir, sfs)                statvfs((dir), (sfs))
 173 #   define OSL_detail_STATFS_BLKSIZ(a)                ((sal_uInt64)((a).f_frsize))
 174 #   define OSL_detail_STATFS_TYPENAME(a)              ((a).f_basetype)
 175 #   define OSL_detail_STATFS_ISREMOTE(a)              (rtl_str_compare((a).f_basetype, "nfs") == 0)
 176
 177 /* always return true if queried for the properties of
 178    the file system. If you think this is wrong under any
 179    of the target platforms fix it!!!! */
 180 #   define OSL_detail_STATFS_IS_CASE_SENSITIVE_FS(a)  (true)
 181 #   define OSL_detail_STATFS_IS_CASE_PRESERVING_FS(a) (true)
 182 #endif /* __sun */
 183
 184 #   define OSL_detail_STATFS_INIT(a)         (memset(&(a), 0, sizeof(OSL_detail_STATFS_STRUCT)))
 185
 186 #else /* no statfs available */
 187
 188 #   define OSL_detail_STATFS_STRUCT                   struct dummy {int i;}
 189 #   define OSL_detail_STATFS_INIT(a)                  ((void)a)
 190 #   define OSL_detail_STATFS(dir, sfs)                (1)
 191 #   define OSL_detail_STATFS_ISREMOTE(sfs)            (false)
 192 #   define OSL_detail_STATFS_IS_CASE_SENSITIVE_FS(a)  (true)
 193 #   define OSL_detail_STATFS_IS_CASE_PRESERVING_FS(a) (true)
 194 #endif /* HAVE_STATFS_H */
 195
 196 static oslFileError osl_psz_getVolumeInformation (
 197     const char* pszDirectory, oslVolumeInfo* pInfo, sal_uInt32 uFieldMask)
 198 {
 199     if (!pInfo)
 200         return osl_File_E_INVAL;
 201
 202     pInfo->uValidFields = 0;
 203     pInfo->uAttributes  = 0;
 204     pInfo->uTotalSpace = 0;
 205     pInfo->uFreeSpace  = 0;
 206     pInfo->uUsedSpace  = 0;
 207
 208     if ((uFieldMask
 209          & (osl_VolumeInfo_Mask_Attributes | osl_VolumeInfo_Mask_TotalSpace
 210             | osl_VolumeInfo_Mask_UsedSpace | osl_VolumeInfo_Mask_FreeSpace
 211             | osl_VolumeInfo_Mask_FileSystemName
 212             | osl_VolumeInfo_Mask_FileSystemCaseHandling))
 213         != 0)
 214     {
 215         OSL_detail_STATFS_STRUCT sfs;
 216         OSL_detail_STATFS_INIT(sfs);
 217         // coverity[fs_check_call : FALSE]
 218         if ((OSL_detail_STATFS(pszDirectory, &sfs)) < (0))
 219         {
 220             oslFileError result = oslTranslateFileError(errno);
 221             return result;
 222         }
 223
 224         /* FIXME: how to detect the kind of storage (fixed, cdrom, ...) */
 225         if (uFieldMask & osl_VolumeInfo_Mask_Attributes)
 226         {
 227             bool const remote = OSL_detail_STATFS_ISREMOTE(sfs);
 228                 // extracted from the 'if' to avoid Clang -Wunreachable-code
 229             if (remote)
 230                 pInfo->uAttributes  |= osl_Volume_Attribute_Remote;
 231
 232             pInfo->uValidFields |= osl_VolumeInfo_Mask_Attributes;
 233         }
 234
 235         if (uFieldMask & osl_VolumeInfo_Mask_FileSystemCaseHandling)
 236         {
 237             if (OSL_detail_STATFS_IS_CASE_SENSITIVE_FS(sfs))
 238                 pInfo->uAttributes |= osl_Volume_Attribute_Case_Sensitive;
 239
 240             if (OSL_detail_STATFS_IS_CASE_PRESERVING_FS(sfs))
 241                 pInfo->uAttributes |= osl_Volume_Attribute_Case_Is_Preserved;
 242
 243             pInfo->uValidFields |= osl_VolumeInfo_Mask_Attributes;
 244         }
 245
 246 #if defined(OSL_detail_STATFS_BLKSIZ)
 247
 248         if ((uFieldMask & osl_VolumeInfo_Mask_TotalSpace) ||
 249             (uFieldMask & osl_VolumeInfo_Mask_UsedSpace))
 250         {
 251             pInfo->uTotalSpace   = OSL_detail_STATFS_BLKSIZ(sfs);
 252             pInfo->uTotalSpace  *= static_cast<sal_uInt64>(sfs.f_blocks);
 253             pInfo->uValidFields |= osl_VolumeInfo_Mask_TotalSpace;
 254         }
 255
 256         if ((uFieldMask & osl_VolumeInfo_Mask_FreeSpace) ||
 257             (uFieldMask & osl_VolumeInfo_Mask_UsedSpace))
 258         {
 259             pInfo->uFreeSpace = OSL_detail_STATFS_BLKSIZ(sfs);
 260
 261             if (getuid() == 0)
 262                 pInfo->uFreeSpace *= static_cast<sal_uInt64>(sfs.f_bfree);
 263             else
 264                 pInfo->uFreeSpace *= static_cast<sal_uInt64>(sfs.f_bavail);
 265
 266             pInfo->uValidFields |= osl_VolumeInfo_Mask_FreeSpace;
 267         }
 268
 269         if ((pInfo->uValidFields & osl_VolumeInfo_Mask_TotalSpace) &&
 270             (pInfo->uValidFields & osl_VolumeInfo_Mask_FreeSpace ))
 271         {
 272             pInfo->uUsedSpace    = pInfo->uTotalSpace - pInfo->uFreeSpace;
 273             pInfo->uValidFields |= osl_VolumeInfo_Mask_UsedSpace;
 274         }
 275
 276 #endif  /* OSL_detail_STATFS_BLKSIZ */
 277
 278 #if defined(OSL_detail_STATFS_TYPENAME)
 279
 280         if (uFieldMask & osl_VolumeInfo_Mask_FileSystemName)
 281         {
 282             rtl_string2UString(
 283                 &(pInfo->ustrFileSystemName),
 284                 OSL_detail_STATFS_TYPENAME(sfs),
 285                 rtl_str_getLength(OSL_detail_STATFS_TYPENAME(sfs)),
 286                 osl_getThreadTextEncoding(),
 287                 OUSTRING_TO_OSTRING_CVTFLAGS);
 288             OSL_ASSERT(pInfo->ustrFileSystemName != nullptr);
 289
 290             pInfo->uValidFields |= osl_VolumeInfo_Mask_FileSystemName;
 291         }
 292
 293 #endif /* OSL_detail_STATFS_TYPENAME */
 294     }
 295
 296     pInfo->uMaxNameLength = 0;
 297     if (uFieldMask & osl_VolumeInfo_Mask_MaxNameLength)
 298     {
 299         long nLen = pathconf(pszDirectory, _PC_NAME_MAX);
 300         if (nLen > 0)
 301         {
 302             pInfo->uMaxNameLength = static_cast<sal_uInt32>(nLen);
 303             pInfo->uValidFields |= osl_VolumeInfo_Mask_MaxNameLength;
 304         }
 305     }
 306
 307     pInfo->uMaxPathLength = 0;
 308     if (uFieldMask & osl_VolumeInfo_Mask_MaxPathLength)
 309     {
 310         long nLen = pathconf (pszDirectory, _PC_PATH_MAX);
 311         if (nLen > 0)
 312         {
 313             pInfo->uMaxPathLength  = static_cast<sal_uInt32>(nLen);
 314             pInfo->uValidFields   |= osl_VolumeInfo_Mask_MaxPathLength;
 315         }
 316     }
 317
 318     return osl_File_E_None;
 319 }
 320
 321 oslFileError osl_getVolumeDeviceMountPath( oslVolumeDeviceHandle, rtl_uString ** )
 322 {
 323     return osl_File_E_INVAL;
 324 }
 325
 326 oslFileError osl_acquireVolumeDeviceHandle( oslVolumeDeviceHandle )
 327 {
 328     return osl_File_E_INVAL;
 329 }
 330
 331 oslFileError osl_releaseVolumeDeviceHandle( oslVolumeDeviceHandle )
 332 {
 333     return osl_File_E_INVAL;
 334 }
 335
 336 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */