EdgeScript menyediakan fungsi bawaan untuk memanipulasi header permintaan dan respons HTTP, menulis ulang atau mengalihkan URI, menghasilkan badan respons, serta mengatur cookie. Referensi ini mencakup sintaksis, parameter, Nilai kembali, dan contoh untuk setiap fungsi.
Lompat ke:
Header permintaan:
add_req_header,del_req_headerHeader respons:
add_rsp_header,del_rsp_header,get_rsp_headerPenulisan ulang dan pengalihan URL:
rewriteBadan respons:
say,print,exitCookie:
add_rsp_cookieEncoding:
encode_args,decode_args
Header permintaan
add_req_header
Menambahkan header permintaan sebelum permintaan diteruskan ke origin server.
Sintaksis
add_req_header(name, value [, append])Parameter
Parameter | Tipe | Wajib | Deskripsi |
| string | Ya | Nama header permintaan yang akan ditambahkan. |
| string | Ya | Nilai header permintaan yang akan ditambahkan. |
| Boolean | Tidak | Menentukan apakah header akan ditambahkan jika header dengan nama yang sama sudah ada. Default: |
Nilai kembali
Secara default mengembalikan true. Mengembalikan false jika nama header tidak valid.
Contoh
add_req_header('USER-DEFINED-REQ-1', '1')
add_req_header('USER-DEFINED-REQ-1', 'x', true)
add_req_header('USER-DEFINED-REQ-2', '2')
del_req_header('USER-DEFINED-REQ-2')Hasil: Origin server menerima header berikut:
USER-DEFINED-REQ-1: 1
USER-DEFINED-REQ-1: xUSER-DEFINED-REQ-2 ditambahkan kemudian dihapus, sehingga tidak diteruskan ke origin server.
del_req_header
Menghapus header permintaan sebelum permintaan diteruskan ke origin server.
Sintaksis
del_req_header(name)Parameter
Parameter | Tipe | Wajib | Deskripsi |
| string | Ya | Nama header permintaan yang akan dihapus. |
Nilai kembali
Secara default mengembalikan true. Mengembalikan false jika nama header tidak valid.
Contoh
add_req_header('USER-DEFINED-REQ-1', '1')
add_req_header('USER-DEFINED-REQ-1', 'x', true)
add_req_header('USER-DEFINED-REQ-2', '2')
del_req_header('USER-DEFINED-REQ-2')Hasil: Origin server menerima header berikut:
USER-DEFINED-REQ-1: 1
USER-DEFINED-REQ-1: xUSER-DEFINED-REQ-2 ditambahkan kemudian dihapus, sehingga tidak diteruskan ke origin server.
Header respons
add_rsp_header
Menambahkan header respons.
Sintaksis
add_rsp_header(name, value [, append])Parameter
Parameter | Tipe | Wajib | Deskripsi |
| string | Ya | Nama header respons yang akan ditambahkan. |
| string | Ya | Nilai header respons yang akan ditambahkan. Mendukung ekspresi dinamis: |
| Boolean | Tidak | Menentukan apakah header akan ditambahkan jika header dengan nama yang sama sudah ada. Default: |
Nilai kembali
Secara default mengembalikan true. Mengembalikan false jika nama header tidak valid.
Contoh
add_rsp_header('USER-DEFINED-RSP-1', '1')
add_rsp_header('USER-DEFINED-RSP-1', 'x', true)
add_rsp_header('USER-DEFINED-RSP-2', '2')
del_rsp_header('USER-DEFINED-RSP-2')Hasil: Respons menyertakan header berikut:
USER-DEFINED-RSP-1: 1
USER-DEFINED-RSP-1: xUSER-DEFINED-RSP-2 ditambahkan kemudian dihapus, sehingga tidak disertakan dalam respons.
del_rsp_header
Menghapus header respons.
Sintaksis
del_rsp_header(name)Parameter
Parameter | Tipe | Wajib | Deskripsi |
| string | Ya | Nama header respons yang akan dihapus. |
Nilai kembali
Secara default mengembalikan true. Mengembalikan false jika nama header tidak valid.
Contoh
add_rsp_header('USER-DEFINED-RSP-1', '1')
add_rsp_header('USER-DEFINED-RSP-1', 'x', true)
add_rsp_header('USER-DEFINED-RSP-2', '2')
del_rsp_header('USER-DEFINED-RSP-2')Hasil: Respons menyertakan header berikut:
USER-DEFINED-RSP-1: 1
USER-DEFINED-RSP-1: xUSER-DEFINED-RSP-2 ditambahkan kemudian dihapus, sehingga tidak disertakan dalam respons.
get_rsp_header
Mengambil nilai header respons.
Sintaksis
get_rsp_header(str)Parameter
Parameter | Tipe | Wajib | Deskripsi |
| string | Ya | Nama header respons yang akan diambil. |
Nilai kembali
Jika header ada: Mengembalikan nilai header sebagai string, angka, dictionary, atau Boolean.
Jika header tidak ada: Mengembalikan
false.
Contoh
ct = get_rsp_header('content-type')
if ct {
add_rsp_header('origin-content-type', 'is')
} else {
add_rsp_header('origin-content-type', 'no')
}Penulisan ulang dan pengalihan URL
rewrite
Menulis ulang URI atau mengalihkan permintaan.
Sintaksis
rewrite(url, flag, code)Parameter
Parameter | Tipe | Wajib | Deskripsi |
| string | Ya | URI atau URL target setelah penulisan ulang atau pengalihan. |
| string | Ya | Mode penulisan ulang. Lihat tabel referensi flag di bawah ini. |
| numeric | Tidak | Kode status HTTP untuk pengalihan. Hanya berlaku jika |
Referensi flag
Gunakan tabel berikut untuk memilih flag yang sesuai dengan kasus penggunaan Anda:
Hanya URI | URI + parameter kueri | |
Penulisan ulang sisi server (tanpa pengalihan, URL di browser tidak berubah) |
|
|
Pengalihan sisi client (browser membuat permintaan baru, URL berubah) |
|
|
Nilai kembali
Operasi penulisan ulang (
break,enhance_break): Mengembalikantrue.Operasi pengalihan (
redirect,enhance_redirect): Tidak ada Nilai kembali.
Contoh
Penulisan ulang sisi server (URI + parameter)
if and($arg_mode, eq($arg_mode, 'rewrite:enhance_break')) {
rewrite('/a/example/examplefile.txt?k=v', 'enhance_break')
}Origin server menerima permintaan dengan URI dan parameter kueri yang telah ditulis ulang menjadi /a/example/examplefile.txt?k=v.
Pengalihan sisi klien (URI + parameter)
if and($arg_mode, eq($arg_mode, 'rewrite:enhance_redirect')) {
rewrite('/a/example/examplefile.txt?k=v', 'enhance_redirect')
}
if and($arg_mode, eq($arg_mode, 'rewrite:enhance_redirect_301')) {
rewrite('/a/example/examplefile.txt?k=v', 'enhance_redirect', 301)
}Klien menerima pengalihan 302 atau 301 ke /a/example/examplefile.txt?k=v.
Penulisan ulang sisi server (Hanya URI)
if and($arg_mode, eq($arg_mode, 'rewrite:break')) {
rewrite('/a/example/examplefile.txt', 'break')
}Origin server menerima permintaan dengan URI yang telah ditulis ulang menjadi /a/example/examplefile.txt. Parameter kueri asli tetap dipertahankan.
Pengalihan sisi klien (Hanya URI)
if and($arg_mode, eq($arg_mode, 'rewrite:redirect')) {
rewrite('/a/example/examplefile.txt', 'redirect')
}
if and($arg_mode, eq($arg_mode, 'rewrite:redirect_301')) {
rewrite('/a/example/examplefile.txt', 'redirect', 301)
}Klien menerima pengalihan 302 atau 301 ke /a/example/examplefile.txt. Parameter kueri asli tetap dipertahankan.
Badan respons
say
Mencetak konten ke badan respons dan menambahkan karakter baris baru.
Sintaksis
say(arg)Parameter
Parameter | Tipe | Wajib | Deskripsi |
| any | Ya | Konten yang akan ditulis ke badan respons. |
Nilai kembali
Tidak ada.
Contoh
say('hello')
say('hello')Output:
hello
helloMencetak konten ke badan respons tanpa menambahkan karakter baris baru.
Sintaksis
print(arg)Parameter
Parameter | Tipe | Wajib | Deskripsi |
| any | Ya | Konten yang akan ditulis ke badan respons. |
Nilai kembali
Tidak ada.
Contoh
print('byebye')
print('byebye')Output:
byebyebyebyeexit
Mengakhiri permintaan saat ini dengan kode status HTTP yang ditentukan dan badan respons opsional.
Sintaksis
exit(code [, body])Parameter
Parameter | Tipe | Wajib | Deskripsi |
| numeric | Ya | Kode status HTTP yang akan dikembalikan. |
| any | Tidak | Badan respons yang akan disertakan dalam respons. |
Nilai kembali
Tidak ada.
Contoh
Contoh 1: Memblokir permintaan berdasarkan parameter kueri dan cookie
if not($arg_key) {
exit(403)
}Jika permintaan tidak menyertakan parameter kueri key, node CDN akan mengembalikan HTTP 403.
if not($cookie_user) {
exit(403, 'not cookie user')
}Jika permintaan tidak menyertakan cookie user, node CDN akan mengembalikan HTTP 403 dengan badan respons not cookie user.
if not(0) {
exit(403)
}not(0) dievaluasi menjadi false, sehingga blok ini tidak dieksekusi.
if not(false) {
exit(403)
}not(false) dievaluasi menjadi true, sehingga node CDN mengembalikan HTTP 403.
Contoh 2: Autentikasi berbasis URI
pcs = capture_re($request_uri,'^/([^/]+)/([^/]+)([^?]+)\?(.*)')
sec1 = get(pcs, 1)
sec2 = get(pcs, 2)
sec3 = get(pcs, 3)
if or(not(sec1), not(sec2), not(sec3)) {
add_rsp_header('X-TENGINE-ERROR', 'auth failed - missing necessary uri set')
exit(403)
}
digest = md5(concat(sec1, sec3))
if ne(digest, sec2) {
add_rsp_header('X-TENGINE-ERROR', 'auth failed - invalid digest')
exit(403)
}Contoh ini mengekstrak segmen dari URI permintaan, menghitung digest MD5, dan memvalidasinya terhadap signature yang disematkan. Jika format URI salah atau digest tidak sesuai, node CDN akan mengembalikan HTTP 403 beserta header error.
Cookie
add_rsp_cookie
Mengatur cookie dalam respons. Setiap pemanggilan menghasilkan header respons Set-Cookie baru.
Sintaksis
add_rsp_cookie(k, v [, properties])Parameter
Parameter | Tipe | Wajib | Deskripsi |
| string | Ya | Nama cookie. |
| string | Ya | Nilai cookie. |
| dictionary | Tidak | Atribut cookie seperti |
Nilai kembali
Mengembalikan true jika cookie berhasil diatur. Mengembalikan false jika pengaturan cookie gagal.
Contoh
add_rsp_cookie('user', 'edgescript')
add_rsp_cookie('login_time', tostring(now()), [
'path' = '/'
])
expires = cookie_time(time())
add_rsp_cookie('psid', 'SDF93745HFSDF2934JKHG', [
'path' = '/play',
'domain' = 'foo.com',
'secure' = true,
'httponly' = true,
'expires' = expires,
'max_age' = 100,
'samesite' = 'Strict',
'extension' = 'xxt3s'
])Respons menyertakan header Set-Cookie berikut:
Set-Cookie: user=edgescript
Set-Cookie: login_time=1582538968.912; Path=/
Set-Cookie: psid=SDF93745HFSDF2934JKHG; Expires=Mon, 24-Feb-20 10:09:28 GMT; Max-Age=100; Domain=foo.com; Path=/play; Secure; HttpOnly; SameSite=Strict; xxt3sEncoding
encode_args
Mengonversi pasangan kunci-nilai dalam dictionary menjadi string yang ter-encode URI dalam format k1=v1&k2=v2.
Sintaksis
encode_args(d)Parameter
Parameter | Tipe | Wajib | Deskripsi |
| dictionary | Ya | Dictionary yang akan di-encode. |
Nilai kembali
Mengembalikan string yang ter-encode URI.
Contoh
encode_args dan decode_args umumnya digunakan bersama-sama. Contoh berikut meng-encode sebuah dictionary, menetapkannya sebagai header respons, kemudian men-decode-nya dan membaca nilai individual:
my_args = []
set(my_args, 'signature', 'da9dc4b7-87ae-4330-aaaf-e5454e2c2af1')
set(my_args, 'algo', 'private sign1')
my_args_str = encode_args(my_args)
add_rsp_header('X-DSL-ENCODE-ARGS', my_args_str)
to_args = decode_args(my_args_str)
if get(to_args, 'algo') {
add_rsp_header('X-DSL-DECODE-ARGS-ALGO', get(to_args, 'algo'))
}
if get(to_args, 'signature') {
add_rsp_header('X-DSL-DECODE-ARGS-SIGN', get(to_args, 'signature'))
}Respons menyertakan header berikut:
X-DSL-ENCODE-ARGS: signature=da9dc4b7-87ae-4330-aaaf-e5454e2c2af1&algo=private%20sign1
X-DSL-DECODE-ARGS-ALGO: private sign1
X-DSL-DECODE-ARGS-SIGN: da9dc4b7-87ae-4330-aaaf-e5454e2c2af1decode_args
Mengonversi string yang ter-encode URI dalam format k1=v1&k2=v2 menjadi dictionary.
Sintaksis
decode_args(s)Parameter
Parameter | Tipe | Wajib | Deskripsi |
| string | Ya | String ter-encode URI yang akan di-decode. |
Nilai kembali
Mengembalikan dictionary hasil konversi dari string.
Contoh
Lihat contoh encode_args di atas. decode_args merupakan operasi kebalikannya dan digunakan bersama dengan encode_args.