/*
+----------------------------------------------------------------------+
| Swoole |
+----------------------------------------------------------------------+
| This source file is subject to version 2.0 of the Apache license, |
| that is bundled with this package in the file LICENSE, and is |
| available through the world-wide-web at the following url: |
| http://www.apache.org/licenses/LICENSE-2.0.html |
| If you did not receive a copy of the Apache2.0 license and are unable|
| to obtain it through the world-wide-web, please send a note to |
| [email protected] so we can mail you a copy immediately. |
+----------------------------------------------------------------------+
| Author: Tianfeng Han <[email protected]> |
+----------------------------------------------------------------------+
*/
#pragma once
#include "swoole_string.h"
#include <sys/file.h>
#include <sys/stat.h>
#include <fcntl.h>
namespace swoole {
ssize_t file_get_size(FILE *fp);
ssize_t file_get_size(int fd);
ssize_t file_get_size(const std::string &filename);
std::shared_ptr<String> file_get_contents(const std::string &filename);
bool file_put_contents(const std::string &filename, const char *content, size_t length);
bool file_exists(const std::string &filename);
typedef struct stat FileStatus;
class File {
int fd_;
int flags_;
std::string path_;
public:
enum Flag {
READ = O_RDONLY,
WRITE = O_WRONLY,
RW = O_RDWR,
CREATE = O_CREAT,
EXCL = O_EXCL,
APPEND = O_APPEND,
};
explicit File(const int fd) {
fd_ = fd;
flags_ = 0;
}
File(int fd, const std::string &path) {
fd_ = fd;
path_ = path;
flags_ = 0;
}
File(const std::string &path, int oflags);
File(const std::string &path, int oflags, int mode);
~File();
bool open(const std::string &path, int oflags, int mode = 0);
bool close();
bool stat(FileStatus *_stat) const;
bool ready() const {
return fd_ != -1;
}
ssize_t write(const void *_buf, size_t _n) const {
return ::write(fd_, _buf, _n);
}
ssize_t write(const std::string &str) const {
return ::write(fd_, str.c_str(), str.length());
}
ssize_t read(void *_buf, const size_t _n) const {
return ::read(fd_, _buf, _n);
}
ssize_t pwrite(const void *_buf, size_t _n, off_t _offset) const {
return ::pwrite(fd_, _buf, _n, _offset);
}
ssize_t pread(void *_buf, const size_t _n, off_t _offset) const {
return ::pread(fd_, _buf, _n, _offset);
}
size_t write_all(const void *data, size_t len) const;
size_t read_all(void *buf, size_t len) const;
/**
* Read one line of file, reading ends when __n - 1 bytes have been read,
* or a newline (which is included in the return value),
* or an EOF (read bytes less than __n)
* Returns length of line on success, -1 otherwise.
* NOTE: `buf` must be ended with zero.
*/
ssize_t read_line(void *_buf, size_t _n) const;
std::shared_ptr<String> read_content() const;
bool sync() const {
return ::fsync(fd_) == 0;
}
bool truncate(off_t length) const {
return ::ftruncate(fd_, length) == 0;
}
off_t set_offset(off_t offset) const {
return lseek(fd_, offset, SEEK_SET);
}
off_t get_offset() const {
return lseek(fd_, 0, SEEK_CUR);
}
bool lock(int operation) const {
return ::flock(fd_, operation) == 0;
}
bool unlock() const {
return ::flock(fd_, LOCK_UN) == 0;
}
ssize_t get_size() const {
return file_get_size(fd_);
}
void release() {
fd_ = -1;
}
int get_fd() const {
return fd_;
}
const std::string &get_path() const {
return path_;
}
static bool exists(const std::string &file) {
return ::access(file.c_str(), R_OK) == 0;
}
static bool remove(const std::string &file) {
return ::remove(file.c_str()) == 0;
}
};
File make_tmpfile();
class AsyncFile {
private:
int fd = -1;
int flags_ = 0;
mode_t mode_ = 0;
std::string path_;
public:
AsyncFile(const std::string &path, int flags, int mode);
~AsyncFile();
bool open(const std::string &path, int flags, mode_t mode);
bool close() const;
ssize_t read(void *buf, size_t count) const;
ssize_t write(const void *buf, size_t count) const;
ssize_t write(const String *buf) const {
return write(SW_STRINGL(buf));
}
bool sync() const;
bool truncate(off_t length) const;
bool stat(FileStatus *statbuf) const;
off_t get_offset() const;
off_t set_offset(off_t offset) const;
bool ready() const {
return fd != -1;
}
};
} // namespace swoole