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 int
 124 File::puts(char const* s)
 125 {
 126         DCP_ASSERT(_file);
 127         return fputs(s, _file);
 128 }
 129
 130
 131 File::operator bool() const
 132 {
 133         return _file != nullptr;
 134 }
 135
 136
 137 void
 138 File::checked_write(void const * ptr, size_t size)
 139 {
 140         size_t N = write(ptr, 1, size);
 141         if (N != size) {
 142                 if (ferror(_file)) {
 143                         throw FileError("fwrite error", _path, errno);
 144                 } else {
 145                         throw FileError("Unexpected short write", _path, 0);
 146                 }
 147         }
 148 }
 149
 150
 151 void
 152 File::checked_read(void* ptr, size_t size)
 153 {
 154         size_t N = read(ptr, 1, size);
 155         if (N != size) {
 156                 if (ferror(_file)) {
 157                         throw FileError("fread error %1", _path, errno);
 158                 } else {
 159                         throw FileError("Unexpected short read", _path, 0);
 160                 }
 161         }
 162 }
 163
 164
 165 FILE*
 166 File::take()
 167 {
 168         auto give = _file;
 169         _file = nullptr;
 170         return give;
 171 }
 172
 173
 174 int
 175 File::seek(int64_t offset, int whence)
 176 {
 177         DCP_ASSERT(_file);
 178 #ifdef LIBDCP_WINDOWS
 179         return fseeki64(_file, offset, whence);
 180 #else
 181         return fseek(_file, offset, whence);
 182 #endif
 183 }
 184
 185
 186 int64_t
 187 File::tell()
 188 {
 189         DCP_ASSERT(_file);
 190 #ifdef LIBDCP_WINDOWS
 191         return _ftelli64(_file);
 192 #else
 193         return ftell(_file);
 194 #endif
 195 }
 196
 197
 198
 199 int
 200 File::error ()
 201 {
 202         DCP_ASSERT(_file);
 203         return ferror(_file);
 204 }
 205
 206
 207 /** Windows can't "by default" cope with paths longer than 260 characters, so if you pass such a path to
 208  *  any boost::filesystem method it will fail.  There is a "fix" for this, which is to prepend
 209  *  the string \\?\ to the path.  This will make it work, so long as:
 210  *  - the path is absolute.
 211  *  - the path only uses backslashes.
 212  *  - individual path components are "short enough" (probably less than 255 characters)
 213  *
 214  *  See https://www.boost.org/doc/libs/1_57_0/libs/filesystem/doc/reference.html under
 215  *  "Warning: Long paths on Windows" for some details.
 216  *
 217  *  Our fopen_boost uses this method to get this fix, but any other calls to boost::filesystem
 218  *  will not unless this method is explicitly called to pre-process the pathname.
 219  */
 220 boost::filesystem::path
 221 dcp::fix_long_path (boost::filesystem::path long_path)
 222 {
 223 #ifdef LIBDCP_WINDOWS
 224         using namespace boost::filesystem;
 225
 226         if (boost::algorithm::starts_with(long_path.string(), "\\\\")) {
 227                 /* This could mean it starts with \\ (i.e. a SMB path) or \\?\ (a long path)
 228                  * or a variety of other things... anyway, we'll leave it alone.
 229                  */
 230                 return long_path;
 231         }
 232
 233         /* We have to make the path canonical but we can't call canonical() on the long path
 234          * as it will fail.  So we'll sort of do it ourselves (possibly badly).
 235          */
 236         path fixed = "\\\\?\\";
 237         if (long_path.is_absolute()) {
 238                 fixed += long_path.make_preferred();
 239         } else {
 240                 fixed += boost::filesystem::current_path() / long_path.make_preferred();
 241         }
 242         return fixed;
 243 #else
 244         return long_path;
 245 #endif
 246 }