src/file.cc

   1 /*
   2     Copyright (C) 2022 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of libdcp.
   5
   6     libdcp is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     libdcp is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with libdcp.  If not, see <http://www.gnu.org/licenses/>.
  18
  19     In addition, as a special exception, the copyright holders give
  20     permission to link the code of portions of this program with the
  21     OpenSSL library under certain conditions as described in each
  22     individual source file, and distribute linked combinations
  23     including the two.
  24
  25     You must obey the GNU General Public License in all respects
  26     for all of the code used other than OpenSSL.  If you modify
  27     file(s) with this exception, you may extend this exception to your
  28     version of the file(s), but you are not obligated to do so.  If you
  29     do not wish to do so, delete this exception statement from your
  30     version.  If you delete this exception statement from all source
  31     files in the program, then also delete it here.
  32 */
  33
  34
  35 #include "dcp_assert.h"
  36 #include "file.h"
  37
  38
  39 using namespace dcp;
  40
  41
  42 File::~File()
  43 {
  44         close();
  45 }
  46
  47
  48 File::File(boost::filesystem::path path, std::string mode)
  49         : _path(path)
  50 {
  51 #ifdef LIBDCP_WINDOWS
  52         std::wstring mode_wide(mode.begin(), mode.end());
  53         /* c_str() here should give a UTF-16 string */
  54         _file = _wfopen(fix_long_path(path).c_str(), mode_wide.c_str());
  55 #else
  56         _file = fopen(path.c_str(), mode.c_str());
  57 #endif
  58 }
  59
  60
  61 File::File(File&& other)
  62         : _path(other._path)
  63         , _file(other._file)
  64 {
  65         other._file = nullptr;
  66 }
  67
  68
  69 File&
  70 File::operator=(File&& other)
  71 {
  72         if (*this != other) {
  73                 close();
  74                 _file = other._file;
  75                 other._file = nullptr;
  76         }
  77         return *this;
  78 }
  79
  80
  81 void
  82 File::close()
  83 {
  84         if (_file) {
  85                 fclose(_file);
  86                 _file = nullptr;
  87         }
  88 }
  89
  90
  91 size_t
  92 File::write(const void *ptr, size_t size, size_t nmemb)
  93 {
  94         DCP_ASSERT(_file);
  95         return fwrite(ptr, size, nmemb, _file);
  96 }
  97
  98
  99 size_t
 100 File::read(void *ptr, size_t size, size_t nmemb)
 101 {
 102         DCP_ASSERT(_file);
 103         return fread(ptr, size, nmemb, _file);
 104 }
 105
 106
 107 int
 108 File::eof()
 109 {
 110         DCP_ASSERT(_file);
 111         return feof(_file);
 112 }
 113
 114
 115 char *
 116 File::gets(char *s, int size)
 117 {
 118         DCP_ASSERT(_file);
 119         return fgets(s, size, _file);
 120 }
 121
 122
 123 File::operator bool() const
 124 {
 125         return _file != nullptr;
 126 }
 127
 128
 129 void
 130 File::checked_write(void const * ptr, size_t size)
 131 {
 132         size_t N = write(ptr, 1, size);
 133         if (N != size) {
 134                 if (ferror(_file)) {
 135                         throw FileError("fwrite error", _path, errno);
 136                 } else {
 137                         throw FileError("Unexpected short write", _path, 0);
 138                 }
 139         }
 140 }
 141
 142
 143 void
 144 File::checked_read(void* ptr, size_t size)
 145 {
 146         size_t N = read(ptr, 1, size);
 147         if (N != size) {
 148                 if (ferror(_file)) {
 149                         throw FileError("fread error %1", _path, errno);
 150                 } else {
 151                         throw FileError("Unexpected short read", _path, 0);
 152                 }
 153         }
 154 }
 155
 156
 157 FILE*
 158 File::take()
 159 {
 160         auto give = _file;
 161         _file = nullptr;
 162         return give;
 163 }
 164
 165
 166 int
 167 File::seek(int64_t offset, int whence)
 168 {
 169         DCP_ASSERT(_file);
 170 #ifdef LIBDCP_WINDOWS
 171         return fseeki64(_file, offset, whence);
 172 #else
 173         return fseek(_file, offset, whence);
 174 #endif
 175 }
 176
 177
 178 int64_t
 179 File::tell()
 180 {
 181         DCP_ASSERT(_file);
 182 #ifdef LIBDCP_WINDOWS
 183         return _ftelli64(_file);
 184 #else
 185         return ftell(_file);
 186 #endif
 187 }
 188
 189
 190
 191 int
 192 File::error ()
 193 {
 194         DCP_ASSERT(_file);
 195         return ferror(_file);
 196 }
 197
 198
 199 /** Windows can't "by default" cope with paths longer than 260 characters, so if you pass such a path to
 200  *  any boost::filesystem method it will fail.  There is a "fix" for this, which is to prepend
 201  *  the string \\?\ to the path.  This will make it work, so long as:
 202  *  - the path is absolute.
 203  *  - the path only uses backslashes.
 204  *  - individual path components are "short enough" (probably less than 255 characters)
 205  *
 206  *  See https://www.boost.org/doc/libs/1_57_0/libs/filesystem/doc/reference.html under
 207  *  "Warning: Long paths on Windows" for some details.
 208  *
 209  *  Our fopen_boost uses this method to get this fix, but any other calls to boost::filesystem
 210  *  will not unless this method is explicitly called to pre-process the pathname.
 211  */
 212 boost::filesystem::path
 213 dcp::fix_long_path (boost::filesystem::path long_path)
 214 {
 215 #ifdef LIBDCP_WINDOWS
 216         using namespace boost::filesystem;
 217
 218         if (boost::algorithm::starts_with(long_path.string(), "\\\\")) {
 219                 /* This could mean it starts with \\ (i.e. a SMB path) or \\?\ (a long path)
 220                  * or a variety of other things... anyway, we'll leave it alone.
 221                  */
 222                 return long_path;
 223         }
 224
 225         /* We have to make the path canonical but we can't call canonical() on the long path
 226          * as it will fail.  So we'll sort of do it ourselves (possibly badly).
 227          */
 228         path fixed = "\\\\?\\";
 229         if (long_path.is_absolute()) {
 230                 fixed += long_path.make_preferred();
 231         } else {
 232                 fixed += boost::filesystem::current_path() / long_path.make_preferred();
 233         }
 234         return fixed;
 235 #else
 236         return long_path;
 237 #endif
 238 }