PHP 8.2.30
Preview: swoole_file.h Size: 4.88 KB
//proc/self/root/opt/cloudlinux/alt-php84/root/usr/include/php/ext/swoole/include/swoole_file.h

/*
  +----------------------------------------------------------------------+
  | 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       |
  | license@swoole.com so we can mail you a copy immediately.            |
  +----------------------------------------------------------------------+
  | Author: Tianfeng Han  <rango@swoole.com>                             |
  +----------------------------------------------------------------------+
*/

#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

Directory Contents

Dirs: 0 × Files: 55

Name Size Perms Modified Actions
26.96 KB lrw-r--r-- 2026-03-18 09:07:57
Edit Download
2.02 KB lrw-r--r-- 2026-03-18 09:07:57
Edit Download
2.31 KB lrw-r--r-- 2026-03-18 09:07:58
Edit Download
3.29 KB lrw-r--r-- 2026-03-18 09:07:58
Edit Download
2.30 KB lrw-r--r-- 2026-03-18 09:07:58
Edit Download
1.30 KB lrw-r--r-- 2026-03-18 09:07:59
Edit Download
2.24 KB lrw-r--r-- 2026-03-18 09:08:00
Edit Download
2.37 KB lrw-r--r-- 2026-03-18 09:08:00
Edit Download
11.75 KB lrw-r--r-- 2026-03-18 09:08:00
Edit Download
8.79 KB lrw-r--r-- 2026-03-18 09:08:01
Edit Download
8.92 KB lrw-r--r-- 2026-03-18 09:08:01
Edit Download
5.12 KB lrw-r--r-- 2026-03-18 09:08:02
Edit Download
4.17 KB lrw-r--r-- 2026-03-18 09:08:03
Edit Download
2.75 KB lrw-r--r-- 2026-03-18 09:08:04
Edit Download
17.64 KB lrw-r--r-- 2026-03-18 09:08:04
Edit Download
3.78 KB lrw-r--r-- 2026-03-18 09:08:04
Edit Download
2.42 KB lrw-r--r-- 2026-03-18 09:08:05
Edit Download
6.46 KB lrw-r--r-- 2026-03-18 09:08:06
Edit Download
4.88 KB lrw-r--r-- 2026-03-18 09:08:06
Edit Download
2.76 KB lrw-r--r-- 2026-03-18 09:08:07
Edit Download
1.24 KB lrw-r--r-- 2026-03-18 09:08:07
Edit Download
1.90 KB lrw-r--r-- 2026-03-18 09:08:07
Edit Download
7.24 KB lrw-r--r-- 2026-03-18 09:08:07
Edit Download
8.55 KB lrw-r--r-- 2026-03-18 09:08:07
Edit Download
5.52 KB lrw-r--r-- 2026-03-18 09:08:07
Edit Download
2.02 KB lrw-r--r-- 2026-03-18 09:08:07
Edit Download
3.25 KB lrw-r--r-- 2026-03-18 09:08:07
Edit Download
15.71 KB lrw-r--r-- 2026-03-18 09:08:08
Edit Download
3.18 KB lrw-r--r-- 2026-03-18 09:08:08
Edit Download
2.83 KB lrw-r--r-- 2026-03-18 09:08:08
Edit Download
5.18 KB lrw-r--r-- 2026-03-18 09:08:08
Edit Download
1.42 KB lrw-r--r-- 2026-03-18 09:08:08
Edit Download
2.16 KB lrw-r--r-- 2026-03-18 09:08:09
Edit Download
1.96 KB lrw-r--r-- 2026-03-18 09:08:10
Edit Download
2.60 KB lrw-r--r-- 2026-03-18 09:08:10
Edit Download
13.17 KB lrw-r--r-- 2026-03-18 09:08:10
Edit Download
5.03 KB lrw-r--r-- 2026-03-18 09:08:11
Edit Download
3.30 KB lrw-r--r-- 2026-03-18 09:08:12
Edit Download
12.40 KB lrw-r--r-- 2026-03-18 09:08:13
Edit Download
1.83 KB lrw-r--r-- 2026-03-18 09:08:13
Edit Download
49.72 KB lrw-r--r-- 2026-03-18 09:08:13
Edit Download
2.99 KB lrw-r--r-- 2026-03-18 09:08:13
Edit Download
18.51 KB lrw-r--r-- 2026-03-18 09:08:14
Edit Download
2.31 KB lrw-r--r-- 2026-03-18 09:08:15
Edit Download
1.43 KB lrw-r--r-- 2026-03-18 09:08:15
Edit Download
5.22 KB lrw-r--r-- 2026-03-18 09:08:15
Edit Download
5.21 KB lrw-r--r-- 2026-03-18 09:08:15
Edit Download
7.32 KB lrw-r--r-- 2026-03-18 09:08:16
Edit Download
6.50 KB lrw-r--r-- 2026-03-18 09:08:16
Edit Download
1.99 KB lrw-r--r-- 2026-03-18 09:08:17
Edit Download
4.37 KB lrw-r--r-- 2026-03-18 09:08:17
Edit Download
3.84 KB lrw-r--r-- 2026-03-18 09:08:17
Edit Download
7.49 KB lrw-r--r-- 2026-03-18 09:08:18
Edit Download
1.74 KB lrw-r--r-- 2026-03-18 09:08:18
Edit Download
5.11 KB lrw-r--r-- 2026-03-18 09:08:18
Edit Download

If ZipArchive is unavailable, a .tar will be created (no compression).