xbmc/filesystem/NFSDirectory.cpp

   1 /*
   2  *  Copyright (C) 2011-2018 Team Kodi
   3  *  This file is part of Kodi - https://kodi.tv
   4  *
   5  *  SPDX-License-Identifier: GPL-2.0-or-later
   6  *  See LICENSES/README.md for more information.
   7  */
   8
   9 #ifdef TARGET_WINDOWS
  10 #include <mutex>
  11
  12 #include <sys\stat.h>
  13 #endif
  14
  15 #include "FileItem.h"
  16 #include "FileItemList.h"
  17 #include "NFSDirectory.h"
  18 #include "utils/StringUtils.h"
  19 #include "utils/URIUtils.h"
  20 #include "utils/XTimeUtils.h"
  21 #include "utils/log.h"
  22
  23 #ifdef TARGET_WINDOWS
  24 #include <sys\stat.h>
  25 #endif
  26
  27 using namespace XFILE;
  28 #include <limits.h>
  29 #include <nfsc/libnfs.h>
  30 #include <nfsc/libnfs-raw-nfs.h>
  31
  32 #if defined(TARGET_WINDOWS)
  33 #define S_IFLNK 0120000
  34 #define S_ISBLK(m) (0)
  35 #define S_ISSOCK(m) (0)
  36 #define S_ISLNK(m) ((m & S_IFLNK) != 0)
  37 #define S_ISCHR(m) ((m & _S_IFCHR) != 0)
  38 #define S_ISDIR(m) ((m & _S_IFDIR) != 0)
  39 #define S_ISFIFO(m) ((m & _S_IFIFO) != 0)
  40 #define S_ISREG(m) ((m & _S_IFREG) != 0)
  41 #endif
  42
  43 CNFSDirectory::CNFSDirectory(void)
  44 {
  45   gNfsConnection.AddActiveConnection();
  46 }
  47
  48 CNFSDirectory::~CNFSDirectory(void)
  49 {
  50   gNfsConnection.AddIdleConnection();
  51 }
  52
  53 bool CNFSDirectory::GetDirectoryFromExportList(const std::string& strPath, CFileItemList &items)
  54 {
  55   CURL url(strPath);
  56   std::string nonConstStrPath(strPath);
  57   std::list<std::string> exportList=gNfsConnection.GetExportList(url);
  58
  59   for (const std::string& it : exportList)
  60   {
  61     const std::string& currentExport(it);
  62     URIUtils::RemoveSlashAtEnd(nonConstStrPath);
  63
  64     CFileItemPtr pItem(new CFileItem(currentExport));
  65     std::string path(nonConstStrPath + currentExport);
  66     URIUtils::AddSlashAtEnd(path);
  67     pItem->SetPath(path);
  68     pItem->m_dateTime = 0;
  69
  70     pItem->m_bIsFolder = true;
  71     items.Add(pItem);
  72   }
  73
  74   return exportList.empty() ? false : true;
  75 }
  76
  77 bool CNFSDirectory::GetServerList(CFileItemList &items)
  78 {
  79   struct nfs_server_list *srvrs;
  80   struct nfs_server_list *srv;
  81   bool ret = false;
  82
  83   srvrs = nfs_find_local_servers();
  84
  85   for (srv=srvrs; srv; srv = srv->next)
  86   {
  87       std::string currentExport(srv->addr);
  88
  89       CFileItemPtr pItem(new CFileItem(currentExport));
  90       std::string path("nfs://" + currentExport);
  91       URIUtils::AddSlashAtEnd(path);
  92       pItem->m_dateTime=0;
  93
  94       pItem->SetPath(path);
  95       pItem->m_bIsFolder = true;
  96       items.Add(pItem);
  97       ret = true; //added at least one entry
  98   }
  99   free_nfs_srvr_list(srvrs);
 100
 101   return ret;
 102 }
 103
 104 bool CNFSDirectory::ResolveSymlink( const std::string &dirName, struct nfsdirent *dirent, CURL &resolvedUrl)
 105 {
 106   std::unique_lock<CCriticalSection> lock(gNfsConnection);
 107   int ret = 0;
 108   bool retVal = true;
 109   std::string fullpath = dirName;
 110   char resolvedLink[MAX_PATH];
 111
 112   URIUtils::AddSlashAtEnd(fullpath);
 113   fullpath.append(dirent->name);
 114
 115   resolvedUrl.Reset();
 116   resolvedUrl.SetPort(2049);
 117   resolvedUrl.SetProtocol("nfs");
 118   resolvedUrl.SetHostName(gNfsConnection.GetConnectedIp());
 119
 120   ret = nfs_readlink(gNfsConnection.GetNfsContext(), fullpath.c_str(), resolvedLink, MAX_PATH);
 121
 122   if(ret == 0)
 123   {
 124     nfs_stat_64 tmpBuffer = {};
 125     fullpath = dirName;
 126     URIUtils::AddSlashAtEnd(fullpath);
 127     fullpath.append(resolvedLink);
 128
 129     //special case - if link target is absolute it could be even another export
 130     //intervolume symlinks baby ...
 131     if(resolvedLink[0] == '/')
 132     {
 133       //use the special stat function for using an extra context
 134       //because we are inside of a dir traversal
 135       //and just can't change the global nfs context here
 136       //without destroying something...
 137       fullpath = resolvedLink;
 138       resolvedUrl.SetFileName(fullpath);
 139       ret = gNfsConnection.stat(resolvedUrl, &tmpBuffer);
 140     }
 141     else
 142     {
 143       ret = nfs_stat64(gNfsConnection.GetNfsContext(), fullpath.c_str(), &tmpBuffer);
 144       resolvedUrl.SetFileName(gNfsConnection.GetConnectedExport() + fullpath);
 145     }
 146
 147     if (ret != 0)
 148     {
 149       CLog::Log(LOGERROR, "NFS: Failed to stat({}) on link resolve {}", fullpath,
 150                 nfs_get_error(gNfsConnection.GetNfsContext()));
 151       retVal = false;
 152     }
 153     else
 154     {
 155       dirent->inode = tmpBuffer.nfs_ino;
 156       dirent->mode = tmpBuffer.nfs_mode;
 157       dirent->size = tmpBuffer.nfs_size;
 158       dirent->atime.tv_sec = tmpBuffer.nfs_atime;
 159       dirent->mtime.tv_sec = tmpBuffer.nfs_mtime;
 160       dirent->ctime.tv_sec = tmpBuffer.nfs_ctime;
 161
 162       //map stat mode to nf3type
 163       if (S_ISBLK(tmpBuffer.nfs_mode))
 164       {
 165         dirent->type = NF3BLK;
 166       }
 167       else if (S_ISCHR(tmpBuffer.nfs_mode))
 168       {
 169         dirent->type = NF3CHR;
 170       }
 171       else if (S_ISDIR(tmpBuffer.nfs_mode))
 172       {
 173         dirent->type = NF3DIR;
 174       }
 175       else if (S_ISFIFO(tmpBuffer.nfs_mode))
 176       {
 177         dirent->type = NF3FIFO;
 178       }
 179       else if (S_ISREG(tmpBuffer.nfs_mode))
 180       {
 181         dirent->type = NF3REG;
 182       }
 183       else if (S_ISLNK(tmpBuffer.nfs_mode))
 184       {
 185         dirent->type = NF3LNK;
 186       }
 187       else if (S_ISSOCK(tmpBuffer.nfs_mode))
 188       {
 189         dirent->type = NF3SOCK;
 190       }
 191     }
 192   }
 193   else
 194   {
 195     CLog::Log(LOGERROR, "Failed to readlink({}) {}", fullpath,
 196               nfs_get_error(gNfsConnection.GetNfsContext()));
 197     retVal = false;
 198   }
 199   return retVal;
 200 }
 201
 202 bool CNFSDirectory::GetDirectory(const CURL& url, CFileItemList &items)
 203 {
 204   // We accept nfs://server/path[/file]]]]
 205   int ret = 0;
 206   KODI::TIME::FileTime fileTime, localTime;
 207   std::unique_lock<CCriticalSection> lock(gNfsConnection);
 208   std::string strDirName="";
 209   std::string myStrPath(url.Get());
 210   URIUtils::AddSlashAtEnd(myStrPath); //be sure the dir ends with a slash
 211
 212   if(!gNfsConnection.Connect(url,strDirName))
 213   {
 214     //connect has failed - so try to get the exported filesystems if no path is given to the url
 215     if(url.GetShareName().empty())
 216     {
 217       if(url.GetHostName().empty())
 218       {
 219         return GetServerList(items);
 220       }
 221       else
 222       {
 223         return GetDirectoryFromExportList(myStrPath, items);
 224       }
 225     }
 226     else
 227     {
 228       return false;
 229     }
 230   }
 231
 232   struct nfsdir *nfsdir = NULL;
 233   struct nfsdirent *nfsdirent = NULL;
 234
 235   ret = nfs_opendir(gNfsConnection.GetNfsContext(), strDirName.c_str(), &nfsdir);
 236
 237   if(ret != 0)
 238   {
 239     CLog::Log(LOGERROR, "Failed to open({}) {}", strDirName,
 240               nfs_get_error(gNfsConnection.GetNfsContext()));
 241     return false;
 242   }
 243   lock.unlock();
 244
 245   while((nfsdirent = nfs_readdir(gNfsConnection.GetNfsContext(), nfsdir)) != NULL)
 246   {
 247     struct nfsdirent tmpDirent = *nfsdirent;
 248     std::string strName = tmpDirent.name;
 249     std::string path(myStrPath + strName);
 250     int64_t iSize = 0;
 251     bool bIsDir = false;
 252     int64_t lTimeDate = 0;
 253
 254     //reslove symlinks
 255     if(tmpDirent.type == NF3LNK)
 256     {
 257       CURL linkUrl;
 258       //resolve symlink changes tmpDirent and strName
 259       if(!ResolveSymlink(strDirName,&tmpDirent,linkUrl))
 260       {
 261         continue;
 262       }
 263
 264       path = linkUrl.Get();
 265     }
 266
 267     iSize = tmpDirent.size;
 268     bIsDir = tmpDirent.type == NF3DIR;
 269     lTimeDate = tmpDirent.mtime.tv_sec;
 270
 271     if (!StringUtils::EqualsNoCase(strName,".") && !StringUtils::EqualsNoCase(strName,"..")
 272         && !StringUtils::EqualsNoCase(strName,"lost+found"))
 273     {
 274       if(lTimeDate == 0) // if modification date is missing, use create date
 275       {
 276         lTimeDate = tmpDirent.ctime.tv_sec;
 277       }
 278
 279       long long ll = lTimeDate & 0xffffffff;
 280       ll *= 10000000ll;
 281       ll += 116444736000000000ll;
 282       fileTime.lowDateTime = (DWORD)(ll & 0xffffffff);
 283       fileTime.highDateTime = (DWORD)(ll >> 32);
 284       KODI::TIME::FileTimeToLocalFileTime(&fileTime, &localTime);
 285
 286       CFileItemPtr pItem(new CFileItem(tmpDirent.name));
 287       pItem->m_dateTime=localTime;
 288       pItem->m_dwSize = iSize;
 289
 290       if (bIsDir)
 291       {
 292         URIUtils::AddSlashAtEnd(path);
 293         pItem->m_bIsFolder = true;
 294       }
 295       else
 296       {
 297         pItem->m_bIsFolder = false;
 298       }
 299
 300       if (strName[0] == '.')
 301       {
 302         pItem->SetProperty("file:hidden", true);
 303       }
 304       pItem->SetPath(path);
 305       items.Add(pItem);
 306     }
 307   }
 308
 309   lock.lock();
 310   nfs_closedir(gNfsConnection.GetNfsContext(), nfsdir);//close the dir
 311   lock.unlock();
 312   return true;
 313 }
 314
 315 bool CNFSDirectory::Create(const CURL& url2)
 316 {
 317   int ret = 0;
 318   bool success=true;
 319
 320   std::unique_lock<CCriticalSection> lock(gNfsConnection);
 321   std::string folderName(url2.Get());
 322   URIUtils::RemoveSlashAtEnd(folderName);//mkdir fails if a slash is at the end!!!
 323   CURL url(folderName);
 324   folderName = "";
 325
 326   if(!gNfsConnection.Connect(url,folderName))
 327     return false;
 328
 329   ret = nfs_mkdir(gNfsConnection.GetNfsContext(), folderName.c_str());
 330
 331   success = (ret == 0 || -EEXIST == ret);
 332   if(!success)
 333     CLog::Log(LOGERROR, "NFS: Failed to create({}) {}", folderName,
 334               nfs_get_error(gNfsConnection.GetNfsContext()));
 335   return success;
 336 }
 337
 338 bool CNFSDirectory::Remove(const CURL& url2)
 339 {
 340   int ret = 0;
 341
 342   std::unique_lock<CCriticalSection> lock(gNfsConnection);
 343   std::string folderName(url2.Get());
 344   URIUtils::RemoveSlashAtEnd(folderName);//rmdir fails if a slash is at the end!!!
 345   CURL url(folderName);
 346   folderName = "";
 347
 348   if(!gNfsConnection.Connect(url,folderName))
 349     return false;
 350
 351   ret = nfs_rmdir(gNfsConnection.GetNfsContext(), folderName.c_str());
 352
 353   if(ret != 0 && errno != ENOENT)
 354   {
 355     CLog::Log(LOGERROR, "{} - Error( {} )", __FUNCTION__,
 356               nfs_get_error(gNfsConnection.GetNfsContext()));
 357     return false;
 358   }
 359   return true;
 360 }
 361
 362 bool CNFSDirectory::Exists(const CURL& url2)
 363 {
 364   int ret = 0;
 365
 366   std::unique_lock<CCriticalSection> lock(gNfsConnection);
 367   std::string folderName(url2.Get());
 368   URIUtils::RemoveSlashAtEnd(folderName);//remove slash at end or URIUtils::GetFileName won't return what we want...
 369   CURL url(folderName);
 370   folderName = "";
 371
 372   if(!gNfsConnection.Connect(url,folderName))
 373     return false;
 374
 375   nfs_stat_64 info;
 376   ret = nfs_stat64(gNfsConnection.GetNfsContext(), folderName.c_str(), &info);
 377
 378   if (ret != 0)
 379   {
 380     return false;
 381   }
 382   return S_ISDIR(info.nfs_mode) ? true : false;
 383 }