sal/osl/unx/file_stat.cxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: file_stat.cxx,v $
  10  * $Revision: 1.8 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_sal.hxx"
  33
  34 #ifndef _TYPES_H
  35 #include <sys/types.h>
  36 #endif
  37
  38 #ifndef _LIMITS_H
  39 #include <limits.h>
  40 #endif
  41
  42 #ifndef _UNISTD_H
  43 #include <unistd.h>
  44 #endif
  45
  46 #ifndef _DIRENT_H
  47 #include <dirent.h>
  48 #endif
  49
  50 #include <osl/file.h>
  51
  52 #ifndef _ERRNO_H
  53 #include <errno.h>
  54 #endif
  55
  56 #include <rtl/string.hxx>
  57
  58 #ifndef _OSL_UUNXAPI_H_
  59 #include "uunxapi.hxx"
  60 #endif
  61 #include "file_path_helper.hxx"
  62 #include "file_error_transl.h"
  63
  64 #ifdef _DIRENT_HAVE_D_TYPE
  65 #include "file_impl.hxx"
  66 #endif
  67
  68 namespace /* private */
  69 {
  70
  71     inline void set_file_type(const struct stat& file_stat, oslFileStatus* pStat)
  72     {
  73         /* links to directories state also to be a directory */
  74        if (S_ISLNK(file_stat.st_mode))
  75            pStat->eType = osl_File_Type_Link;
  76        else if (S_ISDIR(file_stat.st_mode))
  77            pStat->eType = osl_File_Type_Directory;
  78        else if (S_ISREG(file_stat.st_mode))
  79            pStat->eType = osl_File_Type_Regular;
  80        else if (S_ISFIFO(file_stat.st_mode))
  81            pStat->eType = osl_File_Type_Fifo;
  82        else if (S_ISSOCK(file_stat.st_mode))
  83            pStat->eType = osl_File_Type_Socket;
  84        else if (S_ISCHR(file_stat.st_mode) || S_ISBLK(file_stat.st_mode))
  85            pStat->eType = osl_File_Type_Special;
  86        else
  87            pStat->eType = osl_File_Type_Unknown;
  88
  89        pStat->uValidFields |= osl_FileStatus_Mask_Type;
  90     }
  91
  92     inline void set_file_access_mask(const struct stat& file_stat, oslFileStatus* pStat)
  93     {
  94         // user permissions
  95         if (S_IRUSR & file_stat.st_mode)
  96             pStat->uAttributes |= osl_File_Attribute_OwnRead;
  97
  98         if (S_IWUSR & file_stat.st_mode)
  99             pStat->uAttributes |= osl_File_Attribute_OwnWrite;
 100
 101         if (S_IXUSR & file_stat.st_mode)
 102             pStat->uAttributes |= osl_File_Attribute_OwnExe;
 103
 104         // group permissions
 105         if (S_IRGRP & file_stat.st_mode)
 106             pStat->uAttributes |= osl_File_Attribute_GrpRead;
 107
 108         if (S_IWGRP & file_stat.st_mode)
 109             pStat->uAttributes |= osl_File_Attribute_GrpWrite;
 110
 111         if (S_IXGRP & file_stat.st_mode)
 112             pStat->uAttributes |= osl_File_Attribute_GrpExe;
 113
 114         // others permissions
 115         if (S_IROTH & file_stat.st_mode)
 116             pStat->uAttributes |= osl_File_Attribute_OthRead;
 117
 118         if (S_IWOTH & file_stat.st_mode)
 119             pStat->uAttributes |= osl_File_Attribute_OthWrite;
 120
 121         if (S_IXOTH & file_stat.st_mode)
 122             pStat->uAttributes |= osl_File_Attribute_OthExe;
 123
 124         pStat->uValidFields |= osl_FileStatus_Mask_Attributes;
 125     }
 126
 127     inline void set_file_access_rights(const struct stat& file_stat, int S_IR, int S_IW, int S_IX, oslFileStatus* pStat)
 128     {
 129         /* we cannot really map osl_File_Attribute_ReadOnly to
 130            the Unix access rights, it's a Windows only flag
 131            that's why the following hack. We set osl_FileStatus_Mask_Attributes
 132            but if there is no read access for a file we clear the flag
 133            again to signal to the caller that there are no file attributes
 134            to read because that's better than to give them incorrect one.
 135         */
 136         pStat->uValidFields |= osl_FileStatus_Mask_Attributes;
 137
 138         if ((0 == (S_IW & file_stat.st_mode)) && (S_IR & file_stat.st_mode))
 139             pStat->uAttributes |= osl_File_Attribute_ReadOnly;
 140
 141         if (S_IX & file_stat.st_mode)
 142             pStat->uAttributes |= osl_File_Attribute_Executable;
 143     }
 144
 145     /* a process may belong to up to NGROUPS_MAX groups, so when
 146        checking group access rights, we have to check all belonging
 147        groups */
 148     inline bool is_in_process_grouplist(const gid_t file_group)
 149     {
 150         // check primary process group
 151
 152         if (getgid() == file_group)
 153             return true;
 154
 155         // check supplementary process groups
 156
 157         gid_t grplist[NGROUPS_MAX];
 158         int   grp_number = getgroups(NGROUPS_MAX, grplist);
 159
 160         for (int i = 0; i < grp_number; i++)
 161         {
 162             if (grplist[i] == file_group)
 163                 return true;
 164         }
 165         return false;
 166     }
 167
 168     /* Currently we are determining the file access right based
 169        on the real user ID not the effective user ID!
 170        We don't use access(...) because access follows links which
 171        may cause performance problems see #97133.
 172     */
 173     inline void set_file_access_rights(const struct stat& file_stat, oslFileStatus* pStat)
 174     {
 175         if (getuid() == file_stat.st_uid)
 176         {
 177             set_file_access_rights(file_stat, S_IRUSR, S_IWUSR, S_IXUSR, pStat);
 178         }
 179         else if (is_in_process_grouplist(file_stat.st_gid))
 180         {
 181             set_file_access_rights(file_stat, S_IRGRP, S_IWGRP, S_IXGRP, pStat);
 182         }
 183         else
 184         {
 185             set_file_access_rights(file_stat, S_IROTH, S_IWOTH, S_IXOTH, pStat);
 186         }
 187     }
 188
 189     inline void set_file_hidden_status(const rtl::OUString& file_path, oslFileStatus* pStat)
 190     {
 191         pStat->uAttributes   = osl::systemPathIsHiddenFileOrDirectoryEntry(file_path) ? osl_File_Attribute_Hidden : 0;
 192         pStat->uValidFields |= osl_FileStatus_Mask_Attributes;
 193     }
 194
 195     /* the set_file_access_rights must be called after set_file_hidden_status(...) and
 196        set_file_access_mask(...) because of the hack in set_file_access_rights(...) */
 197     inline void set_file_attributes(
 198         const rtl::OUString& file_path, const struct stat& file_stat, const sal_uInt32 uFieldMask, oslFileStatus* pStat)
 199     {
 200         set_file_hidden_status(file_path, pStat);
 201         set_file_access_mask(file_stat, pStat);
 202
 203         // we set the file access rights only on demand
 204         // because it's potentially expensive
 205         if (uFieldMask & osl_FileStatus_Mask_Attributes)
 206                set_file_access_rights(file_stat, pStat);
 207     }
 208
 209     inline void set_file_access_time(const struct stat& file_stat, oslFileStatus* pStat)
 210     {
 211         pStat->aAccessTime.Seconds  = file_stat.st_atime;
 212         pStat->aAccessTime.Nanosec  = 0;
 213            pStat->uValidFields        |= osl_FileStatus_Mask_AccessTime;
 214     }
 215
 216     inline void set_file_modify_time(const struct stat& file_stat, oslFileStatus* pStat)
 217     {
 218         pStat->aModifyTime.Seconds  = file_stat.st_mtime;
 219         pStat->aModifyTime.Nanosec  = 0;
 220         pStat->uValidFields        |= osl_FileStatus_Mask_ModifyTime;
 221     }
 222
 223     inline void set_file_size(const struct stat& file_stat, oslFileStatus* pStat)
 224     {
 225         if (S_ISREG(file_stat.st_mode))
 226            {
 227             pStat->uFileSize     = file_stat.st_size;
 228                pStat->uValidFields |= osl_FileStatus_Mask_FileSize;
 229            }
 230     }
 231
 232     /* we only need to call stat or lstat if one of the
 233        following flags is set */
 234 #ifdef _DIRENT_HAVE_D_TYPE
 235     inline bool is_stat_call_necessary(sal_uInt32 field_mask, oslDirectoryItemImpl *pImpl)
 236 #else
 237     inline bool is_stat_call_necessary(sal_uInt32 field_mask)
 238 #endif
 239     {
 240         return (
 241 /* on linux the dirent might have d_type */
 242 #ifdef _DIRENT_HAVE_D_TYPE
 243                 ((field_mask & osl_FileStatus_Mask_Type) && (!pImpl->bHasType || pImpl->DType == DT_UNKNOWN)) ||
 244 #else
 245                 (field_mask & osl_FileStatus_Mask_Type) ||
 246 #endif
 247                 (field_mask & osl_FileStatus_Mask_Attributes) ||
 248                 (field_mask & osl_FileStatus_Mask_CreationTime) ||
 249                 (field_mask & osl_FileStatus_Mask_AccessTime) ||
 250                 (field_mask & osl_FileStatus_Mask_ModifyTime) ||
 251                 (field_mask & osl_FileStatus_Mask_FileSize) ||
 252                 (field_mask & osl_FileStatus_Mask_LinkTargetURL) ||
 253                 (field_mask & osl_FileStatus_Mask_Validate));
 254     }
 255
 256     inline oslFileError set_link_target_url(const rtl::OUString& file_path, oslFileStatus* pStat)
 257     {
 258         rtl::OUString link_target;
 259         if (!osl::realpath(file_path, link_target))
 260             return oslTranslateFileError(OSL_FET_ERROR, errno);
 261
 262         oslFileError osl_error = osl_getFileURLFromSystemPath(link_target.pData, &pStat->ustrLinkTargetURL);
 263         if (osl_error != osl_File_E_None)
 264             return osl_error;
 265
 266         pStat->uValidFields |= osl_FileStatus_Mask_LinkTargetURL;
 267         return osl_File_E_None;
 268     }
 269
 270     inline oslFileError setup_osl_getFileStatus(oslDirectoryItem Item, oslFileStatus* pStat, rtl::OUString& file_path)
 271     {
 272         if ((NULL == Item) || (NULL == pStat))
 273             return osl_File_E_INVAL;
 274
 275 #ifdef _DIRENT_HAVE_D_TYPE
 276         file_path = rtl::OUString(reinterpret_cast<rtl_uString*>(((oslDirectoryItemImpl* ) Item)->ustrFilePath));
 277 #else
 278         file_path = rtl::OUString(reinterpret_cast<rtl_uString*>(Item));
 279 #endif
 280
 281         OSL_ASSERT(file_path.getLength() > 0);
 282
 283         if (file_path.getLength() <= 0)
 284             return osl_File_E_INVAL;
 285
 286         pStat->uValidFields = 0;
 287
 288         return osl_File_E_None;
 289     }
 290
 291 } // end namespace private
 292
 293
 294 /****************************************************************************
 295  *      osl_getFileStatus
 296  ****************************************************************************/
 297
 298 oslFileError SAL_CALL osl_getFileStatus(oslDirectoryItem Item, oslFileStatus* pStat, sal_uInt32 uFieldMask)
 299 {
 300     rtl::OUString file_path;
 301     oslFileError  osl_error = setup_osl_getFileStatus(Item, pStat, file_path);
 302     if (osl_File_E_None != osl_error)
 303         return osl_error;
 304
 305 #if defined(__GNUC__) && (__GNUC__ < 3)
 306     struct ::stat file_stat;
 307 #else
 308     struct stat file_stat;
 309 #endif
 310
 311 #ifdef _DIRENT_HAVE_D_TYPE
 312     oslDirectoryItemImpl* pImpl = (oslDirectoryItemImpl*) Item;
 313     bool bStatNeeded = is_stat_call_necessary(uFieldMask, pImpl);
 314 #else
 315     bool bStatNeeded = is_stat_call_necessary(uFieldMask);
 316 #endif
 317
 318     if (bStatNeeded && (0 != osl::lstat(file_path, file_stat)))
 319         return oslTranslateFileError(OSL_FET_ERROR, errno);
 320
 321     if (bStatNeeded)
 322     {
 323         // we set all these attributes because it's cheap
 324         set_file_type(file_stat, pStat);
 325         set_file_access_time(file_stat, pStat);
 326         set_file_modify_time(file_stat, pStat);
 327         set_file_size(file_stat, pStat);
 328         set_file_attributes(file_path, file_stat, uFieldMask, pStat);
 329
 330         // file exists semantic of osl_FileStatus_Mask_Validate
 331         if ((uFieldMask & osl_FileStatus_Mask_LinkTargetURL) && S_ISLNK(file_stat.st_mode))
 332         {
 333             osl_error = set_link_target_url(file_path, pStat);
 334             if (osl_error != osl_File_E_None)
 335                 return osl_error;
 336         }
 337     }
 338 #ifdef _DIRENT_HAVE_D_TYPE
 339     else if (uFieldMask & osl_FileStatus_Mask_Type)
 340     {
 341         OSL_ASSERT(pImpl->bHasType);
 342
 343         switch(pImpl->DType)
 344         {
 345         case DT_LNK:
 346             pStat->eType = osl_File_Type_Link;
 347             break;
 348         case DT_DIR:
 349             pStat->eType = osl_File_Type_Directory;
 350             break;
 351         case DT_REG:
 352             pStat->eType = osl_File_Type_Regular;
 353             break;
 354         case DT_FIFO:
 355             pStat->eType = osl_File_Type_Fifo;
 356             break;
 357         case DT_SOCK:
 358             pStat->eType = osl_File_Type_Socket;
 359             break;
 360         case DT_CHR:
 361         case DT_BLK:
 362             pStat->eType = osl_File_Type_Special;
 363             break;
 364         default:
 365             OSL_ASSERT(0);
 366             pStat->eType = osl_File_Type_Unknown;
 367         }
 368
 369        pStat->uValidFields |= osl_FileStatus_Mask_Type;
 370     }
 371 #endif
 372
 373     if (uFieldMask & osl_FileStatus_Mask_FileURL)
 374     {
 375         if ((osl_error = osl_getFileURLFromSystemPath(file_path.pData, &pStat->ustrFileURL)) != osl_File_E_None)
 376             return osl_error;
 377
 378         pStat->uValidFields |= osl_FileStatus_Mask_FileURL;
 379     }
 380
 381     if (uFieldMask & osl_FileStatus_Mask_FileName)
 382     {
 383         osl_systemPathGetFileNameOrLastDirectoryPart(file_path.pData, &pStat->ustrFileName);
 384         pStat->uValidFields |= osl_FileStatus_Mask_FileName;
 385        }
 386     return osl_File_E_None;
 387 }
 388