Nginx-WebDAV扩展模块使用与技术文档

1. 安装指南

环境要求

• Nginx 版本 >= 1.13.4
• libxml2 + libxslt

编译与安装

编译 Nginx 时需要同时启用标准模块 ngx_http_dav_module 以及本扩展模块 nginx-dav-ext-module。

静态模块编译

./configure --with-http_dav_module --add-module=/path/to/nginx-dav-ext-module

动态模块编译

./configure --with-http_dav_module --add-dynamic-module=/path/to/nginx-dav-ext-module

注意：如果不启用 ngx_http_dav_module 而尝试编译此扩展模块，将会导致编译错误。

2. 项目使用说明

本项目为 Nginx 提供了完整的 WebDAV 支持功能。标准的 ngx_http_dav_module 只支持部分 WebDAV 方法，如 GET, HEAD, PUT, DELETE, MKCOL, COPY, MOVE 等。为了实现完整的 WebDAV 功能，需要同时启用标准模块和本扩展模块来支持缺失的方法。

测试

模块测试需要标准的 nginx-tests 和 Perl HTTP::DAV 库。

export PERL5LIB=/path/to/nginx-tests/lib
export TEST_NGINX_BINARY=/path/to/nginx
prove t

3. 项目API使用文档

本项目提供了以下指令以实现扩展的 WebDAV 功能：

• dav_ext_methods：在当前作用域中启用指定的 WebDAV 方法。
• dav_ext_lock_zone：定义一个共享的 WebDAV 锁定区域，并指定大小和锁定超时时间。
• dav_ext_lock：在指定作用域中启用 WebDAV 锁定功能。

指令说明

dav_ext_methods

启用 WebDAV 扩展方法。

• 语法：dav_ext_methods [PROPFIND] [OPTIONS] [LOCK] [UNLOCK]
• 作用域：http, server, location

dav_ext_lock_zone

定义 WebDAV 锁定区域。

• 语法：dav_ext_lock_zone zone=NAME:SIZE [timeout=TIMEOUT]
• 作用域：http

dav_ext_lock

启用 WebDAV 锁定。

• 语法：dav_ext_lock zone=NAME
• 作用域：http, server, location

示例

无锁示例

location / {
    root /data/www;

    dav_methods PUT DELETE MKCOL COPY MOVE;
    dav_ext_methods PROPFIND OPTIONS;
}

带锁示例

http {
    dav_ext_lock_zone zone=foo:10m;

    ...

    server {
        ...

        location / {
            root /data/www;

            dav_methods PUT DELETE MKCOL COPY MOVE;
            dav_ext_methods PROPFIND OPTIONS LOCK UNLOCK;
            dav_ext_lock zone=foo;
        }
    }
}

适用于 MacOS 客户端的带锁示例

http {
    dav_ext_lock_zone zone=foo:10m;

    ...

    server {
        ...

        location / {
            root /data/www;

            # 启用创建没有尾部斜线的目录
            set $x $uri$request_method;
            if ($x ~ [^/]MKCOL$) {
                rewrite ^(.*)$ $1/;
            }

            dav_methods PUT DELETE MKCOL COPY MOVE;
            dav_ext_methods PROPFIND OPTIONS LOCK UNLOCK;
            dav_ext_lock zone=foo;
        }
    }
}

4. 项目安装方式

请遵循上述安装指南中的编译与安装步骤进行安装。