fullmoon
1.0.0
يعد Fullmoon إطارًا سريعًا وأبسطًا على شبكة الإنترنت يعتمد على Redbean-خادم ويب محمول قابل للتوزيع.
كل ما هو مطلوب للتطوير والتوزيع يأتي في ملف واحد بدون تبعيات خارجية وبعد العبوة مع تشغيل Redbean على Windows أو Linux أو MacOS. فيما يلي مثال كامل على تطبيق Fullmoon:
local fm = require " fullmoon "
fm . setTemplate ( " hello " , " Hello, {%& name %} " )
fm . setRoute ( " /hello/:name " , function ( r )
return fm . serveContent ( " hello " , { name = r . params . name })
end )
fm . run () بعد تعبئته باستخدام RedBean ، يمكن إطلاقه باستخدام ./redbean.com
Redbean هو خادم ويب من الطحالب القابل للتوزيع بملف واحد مع صفات فريدة وقوية. في حين أن هناك العديد من أطر الويب المستندة إلى LUA (Labis ، Lor ، Sailor ، Pegasus ، وغيرها) ، لا يتكامل أي منها مع Redbean (على الرغم من وجود إطار تجريبي Anpan).
Fullmoon هو إطار ويب خفيف الوزن وأضيق الحد الأدنى المكتوب من منظور عرض جميع القدرات التي يوفرها Redbean من خلال تمديدها وزيادةها بأبسط وأكثر الطرق فعالية. إنه يعمل بسرعة ويأتي مع البطاريات المشمولة (الطرق والقوالب وجيل JSON والمزيد).
يتبع Fullmoon فلسفة LUA ويوفر مجموعة أقل من الأدوات التي يجب دمجها حسب الحاجة والاستخدام كأساس للبناء عليه.
fork منصة ، socket ، ذاكرة مشتركة ، وأكثر من ذلكقم بتنزيل نسخة من Redbean عن طريق تشغيل الأوامر التالية (تخطي الدقة الثانية إذا كانت تشغيل هذه الأوامر على Windows):
curl -o redbean.com https://redbean.dev/redbean-2.2.com
chmod +x redbean.comيمكن استرداد أحدث رقم إصدار بالطلب التالي:
curl https://redbean.dev/latest.txtخيار آخر هو بناء Redbean من المصدر باتباع التعليمات الخاصة ببناء المصدر.
fullmoon.lua إلى .lua/ الدليل.init.lua (على سبيل المثال ، رمز LUA الموضح في الوصف). خيار آخر هو وضع رمز التطبيق في ملف منفصل (على سبيل المثال ، .lua/myapp.lua ) وإضافة require "myapp" إلى .init.lua . هذه هي الطريقة التي يتم بها تقديم جميع الأمثلة المضمنة.
zip redbean.com .init.lua .lua/fullmoon.lua إذا تم تخزين رمز التطبيق في ملف LUA منفصل ، كما هو موضح أعلاه ، تأكد من وضعه داخل .lua/ directory و zip هذا الملف أيضًا.
./redbean.comإذا تم تنفيذ هذا الأمر على Linux ويرمي خطأً حول عدم العثور على مترجم ، فيجب إصلاحه عن طريق تشغيل الأمر التالي (على الرغم من أنه قد لا ينجو من إعادة تشغيل النظام):
sudo sh -c " echo ':APE:M::MZqFpD::/bin/sh:' >/proc/sys/fs/binfmt_misc/register "إذا كان هذا الأمر ينتج أخطاء محيرة على WSL أو النبيذ عند استخدام Redbean 2.x ، فقد يتم إصلاحها عن طريق تعطيل BinfMT_MISC:
sudo sh -c ' echo -1 >/proc/sys/fs/binfmt_misc/status 'قم بتشغيل متصفح يشير إلى http: // localhost: 8080/hello/world ويجب أن يعود "Hello ، World" (على افتراض أن التطبيق يستخدم الرمز الموضح في المقدمة أو في قسم الاستخدام).
يجب أن يكون مثال أبسط (1) تحميل الوحدة النمطية ، (2) تكوين مسار واحد ، و (3) قم بتشغيل التطبيق:
local fm = require " fullmoon " -- (1)
fm . setRoute ( " /hello " , function ( r ) return " Hello, world " end ) -- (2)
fm . run () -- (3) يستجيب هذا التطبيق لأي طلب /hello URL مع إرجاع محتوى "Hello ، World" (ورمز الحالة 200) ويستجيب برمز الحالة 404 لجميع الطلبات الأخرى.
setRoute(route[, action]) : يسجل طريق. إذا كان route عبارة عن سلسلة ، فسيتم استخدامه كتعبير مسار لمقارنة مسار الطلب مقابل. إذا كان جدولًا ، فإن عناصره عبارة عن سلاسل تستخدم كطرق وقيم التجزئة هي شروط يتم فحص الطرق ضدها. إذا كانت المعلمة الثانية هي وظيفة ، فسيتم تنفيذها إذا تم استيفاء جميع الشروط. إذا كانت سلسلة ، فسيتم استخدامها كتعبير مسار ويتم معالجة الطلب كما لو تم إرساله في المسار المحدد (بمثابة إعادة توجيه داخلي). إذا لم يكن أي شرط راضيًا ، فسيتم فحص المسار التالي. يمكن أن يكون تعبير المسار معلمات متعددة وأجزاء اختيارية. يقبل معالج الإجراء جدول طلب يوفر إمكانية الوصول إلى معلمات الطلب والمسار ، وكذلك الرؤوس وملفات تعريف الارتباط والجلسة.
setTemplate(name, template[, parameters]) : يسجل قالب مع الاسم المحدد أو مجموعة من القوالب من الدليل. إذا كان template عبارة عن سلسلة ، فسيتم تجميعه في معالج قالب. إذا كانت وظيفة ، فسيتم تخزينها واستدعاءها عند طلب تقديم القالب. إذا كان جدولًا ، فإن العنصر الأول هو قالب أو وظيفة ويتم استخدام الباقي كخيارات. على سبيل المثال ، يحدد تحديد ContentType كأحد الخيارات رأس Content-Type للمحتوى الذي تم إنشاؤه. يتم توفير العديد من القوالب ( 500 ، json ، وغيرها) بشكل افتراضي ويمكن الكتابة فوقها. parameters عبارة عن جدول مع معلمات القالب المخزنة كأزواج الاسم/القيمة (المشار إليها كمتغيرات في القالب).
serveResponse(status[, headers][, body]) : يرسل استجابة HTTP باستخدام status المقدمة headers وقيم body . headers عبارة عن جدول اختياري مليء بأزواج/أزواج رأس HTTP. إذا تم توفيرها ، فإن هذه المجموعة من الرؤوس تزيل جميع الرؤوس الأخرى المحددة في وقت سابق أثناء التعامل مع نفس الطلب. أسماء الرأس غير حساسة للحالة ، ولكن شريطة أن تكون الأسماء المستعارة لأسماء الرأس مع شرطات حساسة للحالة : {ContentType = "foo"} هو نموذج بديل لـ {["Content-Type"] = "foo"} . body هو سلسلة اختيارية.
serveContent(name, parameters) : يجعل قالب باستخدام معلمات المقدمة. name هو سلسلة تسمي القالب (كما هو محدد بواسطة مكالمة setTemplate ) parameters هي جدول مع معلمات القالب المخزنة كأزواج الاسم/القيمة (المشار إليها كمتغيرات في القالب).
run([options]) : يقوم بتشغيل الخادم باستخدام الطرق التي تم تكوينها. بشكل افتراضي ، يستمع الخادم على المضيف المحلي والمنفذ 8080. يمكن تغيير هذه القيم عن طريق تعيين قيم addr و port في جدول options .
تتطلب أمثلة التشغيل تضمين عبارة require في ملف .init.lua ، والذي يقوم بتحميل الوحدة النمطية مع كل رمز مثال ، لذلك على مثال العرض الذي تم تنفيذه في showcase.lua ، .init.lua يتضمن ما يلي:
-- this is the content of .init.lua
require " showcase "
-- this loads `showcase` module from `.lua/showcase.lua` file,
-- which also loads its `fullmoon` dependency from `.lua/fullmoon.lua`يوضح مثال العرض العديد من ميزات Fullmoon:
serveAsset )serveRedirect )يجب إضافة الملفات التالية إلى RedBean القابلة للتنفيذ/الأرشيف:
.init.lua - تتطلب "عرض" .lua/fullmoon.lua .lua/showcase.lua
يمنح مثال TechEmpower أنواع الاختبارات المختلفة لمعايير إطار الويب باستخدام FullMoon وقاعدة بيانات SQLite في الذاكرة.
يوضح هذا المثال العديد من ميزات Fullmoon/Redbean:
يجب إضافة الملفات التالية إلى RedBean القابلة للتنفيذ/الأرشيف:
.init.lua - تتطلب "TechBench" .lua/fullmoon.lua .lua/techbench.lua
يوضح مثال لوحة HTMX تطبيقًا بسيطًا ينشئ شظايا HTML التي يتم تسليمها إلى العميل باستخدام مكتبة HTMX.
يوضح هذا المثال العديد من ميزات Fullmoon/Redbean:
يجب إضافة الملفات التالية إلى RedBean القابلة للتنفيذ/الأرشيف:
.init.lua - تتطلب "htmxboard" .lua/fullmoon.lua .lua/htmxboard.lua الأصول/الأنماط TMPL/* - جميع الملفات من أمثلة/دليل htmxboard/tmpl
ملاحظة 1: نظرًا لأن جميع البيانات يتم تخزينها في الذاكرة ، يتم تنفيذ هذا المثال في وضع Uniprocess.
ملاحظة 2: هذه الأمثلة تسترجع HTMX ، فرط المكتبات ، والمكتبات القابلة للفرز من الموارد الخارجية ، ولكن يمكن أيضًا تخزين هذه المكتبات كأصول محلية ، وبالتالي توفر حزمة توزيع محمولة مكتفية تمامًا.
يوضح مثال HTMX SSE طريقة لإنشاء أحداث SENT SENT (SSE) التي يمكن دفقها على عميل (والتي تعرض النتائج باستخدام مكتبة HTMX وتمديد SSE الخاص بها).
يوضح هذا المثال العديد من ميزات Fullmoon/Redbean:
streamContent )يجب إضافة الملفات التالية إلى RedBean القابلة للتنفيذ/الأرشيف:
.init.lua - تتطلب "htmxsse" .lua/fullmoon.lua .lua/htmxsse.lua
يتبع كل تطبيق Fullmoon نفس التدفق الأساسي مع خمسة مكونات رئيسية:
دعونا نلقي نظرة على كل من المكونات التي تبدأ من توجيه الطلب.
يعالج Fullmoon كل طلب HTTP باستخدام نفس العملية:
false أو nil يتم إرجاعه من معالج الإجراء (ويواصل العملية خلاف ذلك) بشكل عام ، تربط تعريفات المسار عناوين URL (ومجموعة من الشروط) إلى معالجات الإجراءات (وهي وظيفة LUA العادية). يتم فحص جميع الشروط بترتيب عشوائي لكل عنوان URL الذي يطابق تعريف المسار. بمجرد فشل أي شرط ، يتم إحباط معالجة المسار ويتم التحقق من المسار التالي باستثناء واحد : يمكن لأي شرط تعيين القيمة otherwise ، مما يؤدي إلى استجابة رمز الحالة المحدد.
إذا لم يتطابق أي مسار للطلب ، فسيتم تشغيل معالجة 404 الافتراضية ، والتي يمكن تخصيصها عن طريق تسجيل قالب 404 مخصص ( fm.setTemplate("404", "My 404 page...") ).
يأخذ كل مسار مسار يتطابق تمامًا ، لذا فإن المسار "/hello" يتطابق مع طلبات /hello ولا يتطابق مع /hell ، /hello-world ، أو /hello/world . يستجيب الطريق أدناه بـ "Hello ، World!" لجميع الطلبات الموجهة إلى /hello Path وإرجاع 404 لجميع الطلبات الأخرى.
fm . setRoute ( " /hello " , function ( r ) return " Hello, World! " end ) لمطابقة المسار الذي /hello هو جزء منه فقط ، يمكن استخدام المعلمات الاختيارية و splat.
بالإضافة إلى الطرق الثابتة ، قد يتضمن أي مسار العناصر النائبة للمعلمات ، والتي يتم تحديدها بواسطة A : تليها فورًا اسم المعلمة:
fm . setRoute ( " /hello/:name " ,
function ( r ) return " Hello, " .. ( r . params . name ) end ) كل معلمة تتطابق مع حرف واحد أو أكثر باستثناء / ، لذلك المسار "/hello/:name" تطابق /hello/alice ، /hello/bob ، /hello/123 ولا يتطابق /hello/bob/and/alice (بسبب الملاذات غير المتطابقة إلى الأمام) أو /hello/ (لأن طول الشظية المتطابقة هو صفر).
يمكن أن تتضمن أسماء المعلمات فقط الأحرف الأبجدية الرقمية و _ .
يمكن الوصول إلى المعلمات باستخدام جدول الطلب وجدول params الخاص به ، بحيث يمكن استخدام r.params.name للحصول على قيمة المعلمة name من المثال السابق.
يمكن الإعلان عن أي جزء محدد أو معلمة مسار محددة اختيارية عن طريق لفه إلى أقواس:
fm . setRoute ( " /hello(/:name) " ,
function ( r ) return " Hello, " .. ( r . params . name or " World! " ) end ) في المثال أعلاه ، يتم قبول كلا /hello و /hello/Bob ، ولكن ليس /hello/ ، لأن القطع المدمجة هي جزء من الشظية الاختيارية و :name لا يزال يتوقع حرفًا واحدًا أو أكثر.
أي معلمة اختيارية لا مثيل لها تصبح false مثل قيمتها ، لذلك في الحالة أعلاه "Hello ، World!" يتم إرجاعه لعنوان URL /hello request.
يمكن تحديد أكثر من معلمة اختيارية ويمكن أن تكون شظايا اختيارية متداخلة ، لذلك "/posts(/:pid/comments(/:cid))" و "/posts(/:pid)/comments(/:cid)" هي قيم مسار صالحة.
هناك نوع آخر من المعلمات التي تسمى splat المكتوبة على أنها * وتتطابق مع شخصيات صفر أو أكثر ، بما في ذلك slash ( / ) إلى الأمام. يتم تخزين splat أيضا في جدول params تحت اسم splat . على سبيل المثال /download/my/file.zip يطابق المسار "/download/*" ويحصل splat على قيمة my/file.zip . إذا كانت هناك حاجة إلى العديد من Splats في نفس المسار ، فيمكن تعيين SPLATS أسماء مماثلة للمعلمات الأخرى: /download/*path/*fname.zip (على الرغم من أن نفس النتيجة يمكن تحقيقها باستخدام /download/*path/:fname.zip ، حيث يلتقط أول splat جميع أجزاء المسار باستثناء اسم الملف).
يمكن أن تظهر جميع المعلمات (بما في ذلك SPLAT) في أي جزء من المسار ويمكن أن تكون محاطة بنص آخر ، والذي يحتاج إلى مطابقة بالضبط. هذا يعني أن المسار "/download/*/:name.:ext" يتطابق مع /download/my/path/file.zip و params.name يحصل على file ، params.ext يحصل على zip و params.splat يحصل على قيم my/path .
سبب آخر لاستخدام SPLAT هو السماح بتسجيل طرق متعددة مع نفس المسار لتسجيله في النظام. يقوم التنفيذ الحالي بكتابة المسارات التي تحمل نفس الاسم ولتجنب استخدام SPLAT المسماة لإنشاء مسارات فريدة. على سبيل المثال،
fm . setRoute ( " /*dosomething1 " , function ( r ) return " something 1 " end )
fm . setRoute ( " /*dosomething2 " , function ( r ) return " something 2 " end )يمكن استخدام هذا في المواقف عندما يكون هناك مجموعة من الشروط التي يجب التحقق منها في معالج الإجراء ، وعلى الرغم من أنه قد يكون من الممكن الجمع بين كلا الطريقين في أحدهما ، فمن الأحيان أن ينظف أن تبقيهما منفصلين.
القيمة الافتراضية للمعلمات هي جميع الأحرف (باستثناء / ) طول واحد أو أكثر. لتحديد مجموعة مختلفة من الأحرف الصالحة ، يمكن إضافتها في نهاية الاسم المتغير ؛ على سبيل المثال ، باستخدام :id[%d] بدلاً من :id يغير المعلمة لمطابقة الأرقام فقط.
fm . setRoute ( " /hello(/:id[%d]) " ,
function ( r ) return " Hello, " .. ( r . params . id or " World! " ) end ) يتم دعم فئات حرف LUA التالية: %w ، %d ، %a ، %l ، %u ، و %x ؛ يمكن أيضًا الهروب من أي حرف علامات الترقيم (بما في ذلك % و ] ) بنسبة % . لا يتم دعم الفئات السلبية (المكتوبة في LUA كنسبة %W ) ، ولكن لا يتم دعم بناء الجملة غير المحددة ، لذلك [^%d] يتطابق مع المعلمة التي لا تتضمن أي أرقام.
لاحظ أنه لا يمكن تغيير عدد التكرار (هكذا :id[%d]* ليس وسيلة صالحة لقبول أرقام صفر أو أكثر) ، حيث لا يُسمح سوى بمجموعاتها ولا تزال القيم تقبل إحدى الشخصيات أو أكثر. إذا كانت هناك حاجة إلى مزيد من المرونة في وصف التنسيقات المقبولة ، فيمكن استخدام المدققين المخصصين لتمديد منطق المطابقة.
يمكن الوصول إلى معلمات الاستعلام والنموذج بنفس طريقة معلمات المسار باستخدام جدول params في جدول request الذي يتم تمريره إلى كل معالج الإجراء. لاحظ أنه إذا كان هناك تعارض بين أسماء المعلمة والاستعلام/النماذج ، فإن أسماء المعلمات لها الأسبقية .
هناك حالة خاصة قد تؤدي إلى إرجاع جدول بدلاً من قيمة السلسلة: إذا انتهى اسم معلمة الاستعلام/النموذج في [] ، يتم إرجاع جميع نتائج المطابقة (واحدة أو أكثر) كجدول. على سبيل المثال ، بالنسبة لسلسلة الاستعلام a[]=10&a[]&a[]=12&a[]= قيمة params["a[]"] هي {10, false, 12, ""} .
نظرًا لأن كتابة أسماء المعلمات هذه قد تتطلب عدة أقواس ، يمكن استخدام params.a كاختصار params["a[]"] مع إرجاع كلا النموذجين نفس الجدول.
تتم معالجة المعلمات المتعددة أيضًا عند طلبها ويمكن الوصول إليها بنفس الطريقة التي يتم بها بقية المعلمات باستخدام جدول params . على سبيل المثال ، يمكن استرداد المعلمات ذات الأسماء simple more من رسالة بنوع محتوى multipart/form-data باستخدام params.simple و params.more .
نظرًا لأن بعض المحتوى متعدد المحتوى قد يتضمن رؤوسًا ومعلمات إضافية داخل تلك الرؤوس ، يمكن الوصول إليها مع حقل multipart الجدول لجدول params :
fm . setRoute ({ " /hello " , simple = " value " }, function ( r )
return " Show " .. r . params . simple .. " " .. r . params . multipart . more . data )
end ) يتضمن الجدول multipart جميع أجزاء الرسالة المتعددة (بحيث يمكن تكرارها باستخدام ipairs ) ، ولكنه يسمح أيضًا للوصول باستخدام أسماء المعلمات ( params.multipart.more ). كل عنصر من العناصر هو أيضًا جدول يتضمن الحقول التالية:
nil إذا لم يكن.nil إذا لم يكن. تستهلك هذه المعالجة المتعددة الأنواع الفرعية متعددة الأنواع وتتعامل مع الرسائل المتعددة العودية. كما أنه يدرج جزءًا بقيمة Content-ID التي تتطابق مع معلمة start في الموضع الأول.
على الرغم من كل الأمثلة السابقة التي تظهر طريق واحد ، نادراً ما يكون الأمر في التطبيقات الحقيقية ؛ عند وجود طرق متعددة ، يتم تقييمها دائمًا بالترتيب الذي يتم تسجيله به .
يمكن أن تقوم مكالمة setRoute واحدة أيضًا بتعيين طرق متعددة عندما يكون لديهم نفس مجموعة الشروط ومشاركة نفس معالج الإجراء:
fm . setRoute ({ " /route1 " , " /route2 " }, handler )هذا يعادل مكالمتين ضبط كل مسار بشكل فردي:
fm . setRoute ( " /route1 " , handler )
fm . setRoute ( " /route2 " , handler )بالنظر إلى أن الطرق يتم تقييمها بالترتيب الذي يتم تعيينه به ، يجب تعيين طرق أكثر انتقائية أولاً ، وإلا فقد لا تحصل على فرصة لتقييم:
fm . setRoute ( " /user/bob " , handlerBob )
fm . setRoute ( " /user/:name " , handlerName ) إذا تم تعيين الطرق بالترتيب المعاكس ، فلا يجوز فحص /user/bob أبدًا طالما أن معالج الإجراء "/user/:name" يعيد بعض النتائج غير false .
كما هو موضح سابقًا ، إذا لم يتطابق أي من الطرق ، فسيتم إرجاع استجابة مع رمز الحالة 404. قد تكون هناك حالات عندما لا يكون ذلك مرغوبًا ؛ على سبيل المثال ، عندما يتضمن التطبيق البرامج النصية LUA للتعامل مع الطلبات التي لم يتم تسجيلها بشكل صريح كطرق. في هذه الحالات ، يمكن إضافة مسار الشامل الذي يقوم بتنفيذ معالجة Redbean الافتراضية (يتم استخدام اسم معلمة SPLAT فقط لإزالة الغموض هذا المسار مقابل /* الأخرى التي يمكن استخدامها في مكان آخر):
fm . setRoute ( " /*catchall " , fm . servePath ) يمكن تزويد كل مسار باسم اختياري ، وهو أمر مفيد في الرجوع إلى هذا المسار عندما يحتاج عنوان URL الخاص به بناءً على قيم معلمة محددة. تقبل وظيفة makePath إما اسم الطريق أو عنوان URL للمرارة نفسه وكذلك جدول المعلمة ويعيد مسارًا مع أصحاب المعلمة المأهولة بالسكان:
fm . setRoute ( " /user/:name " , handlerName )
fm . setRoute ({ " /post/:id " , routeName = " post " }, handlerPost )
fm . makePath ( " /user/:name " , { name = " Bob " }) -- > /user/Bob
fm . makePath ( " /post/:id " , { id = 123 }) -- > /post/123
fm . makePath ( " post " , { id = 123 }) -- > /post/123, same as the previous oneإذا كان طريقتان يستخدمان نفس الاسم ، فإن الاسم يرتبط بالسماء الذي تم تسجيله أخيرًا ، ولكن لا يزال كلا الطريقين موجودين.
يمكن أيضًا استخدام اسم المسار مع الطرق الخارجية/الثابتة التي يتم استخدامها فقط لتوليد URL.
إذا تم استخدام المسار فقط لتوليد المسار ، فلن يحتاج حتى إلى وجود معالج مسار:
fm . setRoute ({ " https://youtu.be/:videoid " , routeName = " youtube " })
fm . makePath ( " youtube " , { videoid = " abc " }) -- > https://youtu.be/abcيتم تخطي مسار بدون أي معالج عمل أثناء عملية مطابقة الطريق.
تسمح الطرق الداخلية بإعادة توجيه مجموعة واحدة من عناوين URL إلى واحدة مختلفة. يمكن أن يشير عنوان URL المستهدف إلى مورد ثابت أو نص .lua lua. على سبيل المثال ، إذا كانت هناك حاجة إلى إعادة توجيه طلبات موقع واحد إلى آخر ، فإن التكوين التالي يعيد توجيه طلبات أي موارد تحت /blog/ URL إلى من تحت /new-blog/ URL طالما وجود المورد المستهدف:
fm . setRoute ( " /blog/* " , " /new-blog/* " ) يقبل هذا المسار طلبًا لـ /blog/post1 ويقدم /new-blog/post1 كرده ، طالما وجود أصول /new-blog/post1 . إذا لم يكن الأصل موجودًا ، فسيتم فحص المسار التالي. وبالمثل ، فإن استخدام fm.setRoute("/static/*", "/*") يسبب طلبات /static/help.txt help.txt أن يتم تقديمها /help.txt .
يمكن أن يتضمن كلا عناوين URL المعلمات التي يتم ملؤها إذا تم حلها:
fm . setRoute ( " /blog/:file " , " /new-blog/:file.html " ) -- <<-- serve "nice" URLs
fm . setRoute ( " /new-blog/:file.html " , fm . serveAsset ) -- <<-- serve original URLs يحل هذا المثال عناوين URL "لطيفة" التي تخدم إصدارات "HTML". لاحظ أن هذا لا يؤدي إلى إعادة توجيه جانب العميل عن طريق إعادة رمز حالة 3xx ، ولكن بدلاً من ذلك يتولى إعادة التوجيه داخليًا. لاحظ أيضًا أن هناك حاجة إلى القاعدة الثانية لخدمة عناوين URL "الأصلية" ، حيث لا يتم التعامل معها من خلال القاعدة الأولى ، لأنه إذا كان الطلب من أجل /blog/mylink.html ، فإن عنوان URL المعاد توجيهه هو /new-blog/mylink.html.html ، وهو غير موجود على الأرجح ، لذلك يتم تخطي المسار ويتم فحص المسار التالي. إذا كانت هناك حاجة إلى معالجة فواصل المسار أيضًا ، فيمكن استخدام *path بدلاً من :file ، كما يتيح * فواصل المسار.
إذا احتاج تطبيق ما إلى تنفيذ وظائف مختلفة اعتمادًا على قيم محددة لسمات الطلب (على سبيل request.method == "GET" ، طريقة) ، توفر هذه المكتبة خيارين رئيسيين: (1) request.method == "GET" تحقق) و (2) إضافة شرط يقوم بتصفية الطلبات بحيث تطلب فقط استخدام قيمة السمة المحددة الوصول إلى معالج الإجراء. يصف هذا القسم الخيار الثاني بمزيد من التفصيل.
يستجيب كل مسار مسجل افتراضيًا لجميع أساليب HTTP (Get ، Put ، Post ، إلخ) ، ولكن من الممكن تكوين كل مسار للرد فقط على أساليب HTTP المحددة:
fm . setRoute ( fm . GET " /hello(/:name) " ,
function ( r ) return " Hello, " .. ( r . params . name or " World! " ) end ) في هذه الحالة ، يقوم بناء الجملة fm.GET"/hello(/:name)" بتكوين المسار لقبول فقط طلبات GET . هذا بناء الجملة يعادل تمرير جدول مع المسار وأي ظروف تصفية إضافية:
fm . setRoute ({ " /hello(/:name) " , method = " GET " },
function ( r ) return " Hello, " .. ( r . params . name or " World! " ) end )إذا كانت هناك حاجة إلى أكثر من طريقة واحدة ، فيمكن تمرير جدول مع قائمة بالطرق بدلاً من قيمة سلسلة واحدة:
fm . setRoute ({ " /hello(/:name) " , method = { " GET " , " POST " }},
function ( r ) return " Hello, " .. ( r . params . name or " World! " ) end ) يسمح كل مسار يسمح بطلب GET أيضًا (ضمنيًا) لطلب HEAD ويتم التعامل مع هذا الطلب من خلال إرجاع جميع الرؤوس دون إرسال الجسم نفسه. إذا كان هذا المعالجة الضمنية لسبب ما غير مرغوب فيه ، فإن إضافة HEAD = false إلى جدول الطريقة يعطينه (كما في method = {"GET", "POST", HEAD = false} ).
لاحظ أن الطلبات ذات الأساليب غير المتطابقة لا يتم رفضها ، بل تنطلق من خلال التحقق من خلال الطرق الأخرى وتشغيل رمز الحالة 404 الذي تم إرجاعه إذا لم يتم مطابقة (باستثناء واحد).
بالإضافة إلى method ، يمكن تطبيق شروط أخرى باستخدام host ، clientAddr ، serverAddr ، scheme ، رؤوس الطلبات ، والمعلمات. على سبيل المثال ، يضمن تحديد name = "Bob" كأحد الشروط قيمة المعلمة name ليكون "بوب" حتى يتم استدعاء معالج الإجراء.
يمكن التحقق من أي رأس طلب باستخدام اسم الرأس كمفتاح ، لذلك يتم استيفاء ContentType = "multipart/form-data" إذا كانت قيمة رأس من Content-Type multipart/form-data . لاحظ أن قيمة الرأس قد تتضمن عناصر أخرى (حدود أو charset كجزء من قيمة Content-Type ) ويتم مقارنة نوع الوسائط الفعلي فقط.
نظرًا لأن أسماء الرؤوس والمعلمات والخصائص يمكن أن تتداخل ، يتم فحصها بالترتيب التالي:
ContentType ،method ، port ، host ، إلخ) ، و يتم فحص رأس Host أيضًا أولاً (على الرغم من كونه كلمة واحدة) ، لذا فإن الرجوع إلى مرشحات Host بناءً على Host الرأس ، مع الرجوع إلى مرشحات host بناءً على host العقار.
قيم السلسلة ليست هي القيم الوحيدة التي يمكن استخدامها في الطرق الشرطية. إذا كانت أكثر من قيمة مقبولة ، فإن تمرير جدول يسمح بتوفير قائمة بالقيم المقبولة. على سبيل المثال ، إذا كان Bob و Alice قيمًا مقبولة ، فإن name = {Bob = true, Alice = true} يعبر عن هذا كشرط.
تتيح قيمتان خاصتان تم تمريرهما في الجدول تطبيق إعادة صحة أو صحة نمط :
regex : يقبل سلسلة لها تعبير منتظم. على سبيل المثال ، name = {regex = "^(Bob|Alice)$"} لديه نفس النتيجة التي حققها فحص التجزئة الموضح سابقًا في هذا القسمpattern : يقبل سلسلة مع تعبير نمط لوا. على سبيل المثال ، يقبل name = {pattern = "^%u%l+$"} القيم التي تبدأ بحرف كبير تليها حرف واحد أو أكثر. يمكن دمج هذين الشيكين مع فحص وجود الجدول: name = {Bob = true, regex = "^Alice$"} يقبل كل من قيم Bob و Alice . في حالة فشل فحص الجدول الأول ، يتم إرجاع نتائج regex أو تعبير pattern .
النوع الأخير من المدقق المخصص هو وظيفة. تستقبل الوظيفة المقدمة القيمة للتحقق من صحة ويتم تقييم نتائجها على أنها false أو true . على سبيل المثال ، يضمن تمرير id = tonumber أن قيمة id هي رقم. كمثال آخر ، يضمن clientAddr = fm.isLoopbackIp أن عنوان العميل هو عنوان IP للربطة.
fm . setRoute ({ " /local-only " , clientAddr = fm . isLoopbackIp },
function ( r ) return " Local content " end )حيث يمكن إنشاء وظيفة المدقق ديناميكيًا ، يعمل هذا أيضًا:
local function isLessThan ( n )
return function ( l ) return tonumber ( l ) < n end
end
fm . setRoute ( fm . POST { " /upload " , ContentLength = isLessThan ( 100000 )},
function ( r ) ... handle the upload ... end )من المهم أن تضع في اعتبارك أن وظيفة المدقق تُرجع فعليًا وظيفة تسمى أثناء طلب تطبيق الشيك. في المثال السابق ، تقبل الوظيفة التي تم إرجاعها قيمة الرأس وتقارنها بالحد الذي تم تمريره أثناء إنشائها.
في بعض الحالات ، يعد الفشل في تلبية الشرط سببًا كافيًا لإعادة بعض الاستجابة إلى العميل دون التحقق من طرق أخرى. في حالة كهذه ، يقوم إعداد القيمة otherwise إلى إرجاع رقم أو دالة إما استجابة مع الحالة المحددة أو نتيجة الوظيفة:
local function isLessThan ( n )
return function ( l ) return tonumber ( l ) < n end
end
fm . setRoute ( fm . POST { " /upload " ,
ContentLength = isLessThan ( 100000 ), otherwise = 413
}, function ( r ) ... handle the upload ... end ) في هذا المثال ، يتطابق محرك التوجيه مع المسار ثم يتحقق من الشروط التي تقارن قيمة الأسلوب مع POST وقيمة رأس Content-Length مع نتيجة وظيفة isLessThan . إذا لم يتطابق أحد الشروط ، فسيتم إرجاع رمز الحالة المحدد بواسطة القيمة otherwise مع بقية الاستجابة.
إذا كان الشرط otherwise يحتاج إلى تطبيق فقط على فحص ContentLength ، فيمكن نقل القيمة otherwise مع وظيفة المدقق إلى جدول مرتبط بفحص ContentLength :
fm . setRoute ( fm . POST { " /upload " ,
ContentLength = { isLessThan ( 100000 ), otherwise = 413 }
}, function ( r ) ... handle the upload ... end ) الفرق بين المثالين الأخيرين هو أنه في هذا المثال ، يؤدي فشل فحص ContentLength فقط إلى استجابة 413 (وجميع الطرق الأخرى التي تصل إلى طرق أخرى) ، بينما في كل من method السابقة وفشل فحص ContentLength تؤدي إلى نفس استجابة 413.
لاحظ أنه عندما تكون القيمة التي تم فحصها nil ، يُعتبر الشيك ضد الجدول صالحًا ويتم قبول المسار. على سبيل المثال ، يفشل التحقق من معلمة اختيارية تم إجراؤها مقابل سلسلة ( name = "Bo" ) إذا كانت قيمة params.name nil ، ولكن يتم تمريرها إذا تم إجراء نفس الشيك مقابل جدول ( name = {Bo=true, Mo=true} ) ، بما في ذلك عمليات فحص regex/pattern. إذا لم يكن هذا أمرًا مرغوبًا فيه ، فيمكن أن تتحقق وظيفة المصلحة المخصصة بشكل صريح من القيمة المتوقعة.
النظر في المثال التالي:
fm . setRoute ({ " /hello(/:name) " ,
method = { " GET " , " POST " , otherwise = 405 }},
function ( r ) return " Hello, " .. ( r . params . name or " World! " ) end ) في هذه الحالة ، إذا تم الوصول إلى نقطة النهاية هذه باستخدام طريقة PUT ، ثم بدلاً من التحقق من الطرق الأخرى (نظرًا لأن شرط method غير مستوفى) ، يتم إرجاع رمز الحالة 405 ، كما تم تكوينه مع القيمة المحددة otherwise . كما هو موثق في مكان آخر ، يقبل هذا المسار طلب HEAD أيضًا (حتى عند عدم إدراجه) ، حيث يتم قبول طلب GET .
عند إرجاع رمز الحالة 405 (الطريقة السيئة) وعدم تعيين رأس Allow ، يتم تعيينه على قائمة الطرق المسموح بها في المسار. في الحالة المذكورة أعلاه ، تم تعيينها GET, POST, HEAD, OPTIONS ، ، لأن هذه هي الطرق التي يسمح بها هذا التكوين. إذا كانت القيمة otherwise وظيفة (بدلاً من رقم) ، فإن إرجاع نتيجة مناسبة وإعداد رأس Allow هو مسؤولية هذه الوظيفة.
يمكن أيضًا تعيين القيمة otherwise على وظيفة ، والتي توفر مرونة أكثر من مجرد إعداد رمز الحالة. على سبيل المثال ، يؤدي إعداد otherwise = fm.serveResponse(413, "Payload Too Large") إلى استجابة مع رمز الحالة المحدد والرسالة.
غالبًا ما يتطلب التحقق من صحة نموذج المناولة تحديد مجموعة من الشروط لنفس المعلمة ورسالة خطأ مخصصة قد تحتاج إلى إرجاعها عندما لا يتم استيفاء الشروط ويتم توفيرها بواسطة مصادقة خاصة يتم إرجاعها بواسطة وظيفة makeValidator :
local validator = fm . makeValidator {
{ " name " , minlen = 5 , maxlen = 64 , msg = " Invalid %s format " },
{ " password " , minlen = 5 , maxlen = 128 , msg = " Invalid %s format " },
}
fm . setRoute ( fm . POST { " /signin " , _ = validator }, function ( r )
-- do something useful with name and password
return fm . serveRedirect ( 307 , " / " )
end )في هذا المثال ، تم تكوين المدقق للتحقق من معلمتين - "الاسم" و "كلمة المرور" - لأطوال MIN و MAX وإرجاع رسالة عندما تفشل إحدى المعلمات في الشيك.
نظرًا لأن الفحص الفاشل يتسبب في تخطي المسار ، فإن توفير القيمة otherwise يسمح بإعادة الخطأ كجزء من الاستجابة:
local validator = fm . makeValidator {
{ " name " , minlen = 5 , maxlen = 64 , msg = " Invalid %s format " },
{ " password " , minlen = 5 , maxlen = 128 , msg = " Invalid %s format " },
otherwise = function ( error )
return fm . serveContent ( " signin " , { error = error })
end ,
} في هذه الحالة ، يتلقى المعالج otherwise رسالة الخطأ (أو جدول مع رسائل إذا تم طلبها عن طريق تمرير all الخيار المغطى أدناه) والتي يمكن توفيرها بعد ذلك كمعلمة قالب وإعادتها إلى العميل.
خيار آخر هو استدعاء وظيفة المدقق مباشرة في معالج الإجراء وإعادة نتائجها:
local validator = fm . makeValidator {
{ " name " , minlen = 5 , maxlen = 64 , msg = " Invalid %s format " },
{ " password " , minlen = 5 , maxlen = 128 , msg = " Invalid %s format " },
}
fm . setRoute ( fm . POST { " /signin " }, function ( r )
local valid , error = validator ( r . params )
if valid then
return fm . serveRedirect ( " / " ) -- status code is optional
else
return fm . serveContent ( " signin " , { error = error })
end
end ) في هذا المثال ، يتم استدعاء المدقق مباشرة ويتم تمرير جدول ( r.params ) مع جميع قيم المعلمات للسماح بوظيفة المدقق للتحقق من القيم مقابل القواعد المحددة.
ثم true وظيفة المدقق إلى النجاح أو nil, error للإشارة إلى الفشل في التحقق من إحدى القواعد. يتيح ذلك لفحقة المدقق في assert ما إذا كان البرنامج النصي يحتاج إلى إرجاع خطأ على الفور:
assert ( validator ( r . params )) -- throw an error if validation fails
return fm . serveRedirect ( 307 , " / " ) -- return redirect in other casesتتوفر شيكات المدقق التالية:
minlen : (عدد صحيح) يتحقق من الحد الأدنى من طول السلسلة.maxlen : (عدد صحيح) يتحقق الطول القصوى للسلسلة.test : (وظيفة) يستدعي وظيفة تم تمريرها معلمة واحدة ومن المتوقع أن تعود true أو nil | false [, error] .oneof : ( value | { table of values to be compared against } ) التحقق مما إذا كانت المعلمة تتوافق مع إحدى القيم المقدمة.pattern : (سلسلة) يتحقق مما إذا كانت المعلمة تتطابق مع تعبير نمط LUA.بالإضافة إلى الشيكات ، قد تتضمن القواعد خيارات:
optional : (Bool) يجعل المعلمة اختيارية عندما تكون nil . جميع المعلمات مطلوبة بشكل افتراضي ، لذلك يتيح هذا الخيار تخطي القواعد عند عدم توفير المعلمة. لا تزال جميع القواعد مطبقة إذا لم تكن المعلمة لا شيء.msg : (String) يضيف رسالة عميل لهذا الغرض إذا فشل أحد الشيكات ، والتي تكتب الرسائل من الشيكات الفردية. قد تتضمن الرسالة عنصرًا نائبًا ( %s ) ، والذي سيتم استبداله باسم المعلمة.The validator itself also accepts several options that modify how the generated errors are returned or handled:
otherwise : (function) sets an error handler that is called when one of the checks fails. The function receives the error(s) triggered by the checks.all : (bool) configures the validator to return all errors instead of just the first one. By default only one (first) error is returned as a string, so if all errors are requested, they are returned as a table with each error being a separate item.key : (bool) configures the validator to return error(s) as values in a hash table (instead of element) where the keys are parameter names. This is useful to pass the table with errors to a template that can then display errors.name and errors.password error messages next to their input fields. An action handler receives all incoming HTTP requests filtered for a particular route. Each of the examples shown so far includes an action handler, which is passed as a second parameter to the setRoute method.
Multiple action handlers can be executed in the course of handling one request and as soon as one handler returns a result that is evaluated as a non- false value, the route handling process ends. Returning false or nil from an action handler continues the processing, which allows implementing some common processing that applies to multiple routes (similar to what is done using "before" filters in other frameworks):
local uroute = " /user/:id "
fm . setRoute ({ uroute .. " /* " , method = { " GET " , " POST " , otherwise = 405 }},
function ( r )
-- retrieve user information based on r.params.id
-- and store in r.user (as one of the options);
-- return error if user is not found
return false -- continue handling
end )
fm . setRoute ( fm . GET ( uroute .. " /view " ), function ( r ) ... end )
fm . setRoute ( fm . GET ( uroute .. " /edit " ), function ( r ) ... end )
fm . setRoute ( fm . POST ( uroute .. " /edit " ), function ( r ) ... end )In this example, the first route can generate three outcomes:
method check) is not matched, then the 405 status code is returned.false , which continues processing with other routes, or fails to retrieve the user and returns an error.In general, an action handler can return any of the following values:
true : this stops any further processing, sets the headers that have been specified so far, and returns the generated or set response body.false or nil : this stops the processing of the current route and proceeds to the next one.Content-Type is set based on the body content (using a primitive heuristic) if not set explicitly.serve* methods): this executes the requested method and returns an empty string or true to signal the end of the processing.true is returned (and a warning is logged). Normally any processing that results in a Lua error is returned to the client as a server error response (with the 500 status code). To assist with local debugging, the error message includes a stack trace, but only if the request is sent from a loopback or private IP (or if redbean is launched with the -E command line option).
It may be desirable to return a specific response through multiple layers of function calls, in which case the error may be triggered with a function value instead of a string value. For example, executing error(fm.serve404) results in returning the 404 status code, which is similar to using return fm.serve404 , but can be executed in a function called from an action handler (and only from inside an action handler).
Here is a more complex example that returns the 404 status code if no record is fetched (assuming there is a table test with a field id ):
local function AnyOr404(res, err)
if not res then error(err) end
-- serve 404 when no record is returned
if res == db.NONE then error(fm.serve404) end
return res, err
end
fm.setRoute("/", function(r)
local row = AnyOr404(dbm:fetchOne("SELECT id FROM test"))
return row.id
end)
This example uses the serve404 function, but any other serve* method can also be used.
Each action handler accepts a request table that includes the following attributes:
method : request HTTP method (GET, POST, and others).host : request host (if provided) or the bind address.serverAddr : address to which listening server socket is bound.remoteAddr : client ip4 address encoded as a number. This takes into consideration reverse proxy scenarios. Use formatIp function to convert to a string representing the address.scheme : request URL scheme (if any).path : request URL path that is guaranteed to begin with / .authority : request URL with scheme, host, and port present.url : request URL as an ASCII string with illegal characters percent encoded.body : request message body (if present) or an empty string.date : request date as a Unix timestamp.time : current time as a Unix timestamp with 0.0001s precision.The request table also has several utility functions, as well as headers, cookies, and session tables that allow retrieving request headers, cookies, and session and setting of headers and cookies that are included with the response.
The same request table is given as a parameter to all (matched) action handlers, so it can be used as a mechanism to pass values between those action handlers, as any value assigned as a field in one handler is available in all other action handlers .
The headers table provides access to the request headers. For example, r.headers["Content-Type"] returns the value of the Content-Type header. This form of header access is case-insensitive. A shorter form is also available ( r.headers.ContentType ), but only for registered headers and is case-sensitive with the capitalization preserved.
The request headers can also be set using the same syntax. For example, r.headers.MyHeader = "value" sets MyHeader: value response header. As the headers are set at the end of the action handler processing, headers set earlier can also be removed by assigning a nil value.
Repeatable headers can also be assigned with values separated by commas: r.headers.Allow = "GET, POST" .
The cookies table provides access to the request cookies. For example, r.cookies.token returns the value of the token cookie.
The cookies can also be set using the same syntax. For example, r.cookies.token = "new value" sets token cookie to new value . If the cookie needs to have its attributes set as well, then the value and the attributes need to be passed as a table: r.cookies.token = {"new value", secure = true, httponly = true} .
The following cookie attributes are supported:
expires : sets the maximum lifetime of the cookie as an HTTP-date timestamp. Can be specified as a date in the RFC1123 (string) format or as a UNIX timestamp (number of seconds).maxage : sets number of seconds until the cookie expires. A zero or negative number expires the cookie immediately. If both expires and maxage are set, maxage has precedence.domain : sets the host to which the cookie is going to be sent.path : sets the path that must be present in the request URL, or the client is not going to send the Cookie header.secure : (bool) requests the cookie to be only send to the server when a request is made with the https: scheme.httponly : (bool) forbids JavaScript from accessing the cookie.samesite : ( Strict , Lax , or None ) controls whether a cookie is sent with cross-origin requests, providing some protection against cross-site request forgery attacks. Note that httponly and samesite="Strict" are set by default; a different set of defaults can be provided using cookieOptions passed to the run method. Any attributes set with a table overwrite the default , so if Secure needs to be enabled, make sure to also pass httponly and samesite options.
To delete a cookie, set its value to false : for example, r.cookies.token = false deletes the value of the token cookie.
The session table provides access to the session table that can be used to set or retrieve session values. For example, r.session.counter returns the counter value set previously. The session values can also be set using the same syntax. For example, r.session.counter = 2 sets the counter value to 2 .
The session allows storing of nested values and other Lua values. If the session needs to be removed, it can be set to an empty table or a nil value. Each session is signed with an application secret, which is assigned a random string by default and can be changed by setting session options.
The following functions are available as both request functions (as fields in the request table) and as library functions:
makePath(route[, parameters]) : creates a path from either a route name or a path string by populating its parameters using values from the parameters table (when provided). The path doesn't need to be just a path component of a URL and can be a full URL as well. Optional parts are removed if they include parameters that are not provided.makeUrl([url,] options) : creates a URL using the provided value and a set of URL parameters provided in the options table: scheme, user, pass, host, port, path, and fragment. The url parameter is optional; the current request URL is used if url is not specified. Any of the options can be provided or removed (using false as the value). For example, makeUrl({scheme="https"}) sets the scheme for the current URL to https .escapeHtml(string) : escapes HTML entities ( &><"' ) by replacing them with their HTML entity counterparts ( &><"' ).escapePath(path) : applies URL encoding ( %XX ) escaping path unsafe characters (anything other than -.~_@:!$&'()*+,;=0-9A-Za-z/ ).formatHttpDateTime(seconds) : converts UNIX timestamp (in seconds) to an RFC1123 string ( Mon, 21 Feb 2022 15:37:13 GMT ).Templates provide a simple and convenient way to return a predefined and parametrized content instead of generating it piece by piece.
The included template engine supports mixing an arbitrary text with Lua statements/expressions wrapped into {% %} tags. All the code in templates uses a regular Lua syntax, so there is no new syntax to learn. There are three ways to include some Lua code:
{% statement %} : used for Lua statements . For example, {% if true then %}Hello{% end %} renders Hello .{%& expression %} : used for Lua expressions rendered as HTML-safe text. For example, {%& '2 & 2' %} renders 2 & 2 .{%= expression %} : used for Lua expressions rendered as-is (without escaping). For example, {%= 2 + 2 %} renders 4 . Be careful, as HTML is not escaped with {%= } , this should be used carefully due to the potential for XSS attacks.The template engine provides two main functions to use with templates:
setTemplate(name, text[, parameters]) : registers a template with the provided name and text (and uses parameters as its default parameters). There are special cases where name or text parameters may not be strings, with some of those cases covered in the Loading templates section. parameters is a table with template parameters as name/value pairs (referenced as variables in the template).render(name, parameters) : renders a registered template using the parameters table to set values in the template (with key/value in the table assigned to name/value in the template).There is only one template with a given name, so registering a template with an existing name replaces this previously registered template. This is probably rarely needed, but can be used to overwrite default templates.
Here is an example that renders Hello, World! to the output buffer:
fm . setTemplate ( " hello " , " Hello, {%& title %}! " )
fm . render ( " hello " , { title = " World " })Rendering statements using the expression syntax or expressions using the statement syntax is a syntax error that is reported when the template is registered. Function calls can be used with either syntax.
Any template error (syntax or run-time) includes a template name and a line number within the template. For example, calling fm.setTemplate("hello", "Hello, {%& if title then end %}!") results in throwing hello:1: unexpected symbol near 'if' error (as it inserts a Lua statement using the expression syntax).
Templates can also be loaded from a file or a directory using the same setTemplate function, which is described later in the Loading templates section.
There are several aspects worth noting, as they may differ from how templates are processed in other frameworks:
json and sse templates are implemented using this approach.Each template accepts parameters that then can be used in its rendering logic. Parameters can be passed in two ways: (1) when the template is registered and (2) when the template is rendered. Passing parameters during registration allows to set default values that are used if no parameter is provided during rendering. على سبيل المثال،
fm . setTemplate ( " hello " , " Hello, {%& title %}! " , { title = " World " })
fm . render ( " hello " ) -- renders `Hello, World!`
fm . render ( " hello " , { title = " All " }) -- renders `Hello, All!` nil or false values are rendered as empty strings without throwing any error, but any operation on a nil value is likely to result in a Lua error. For example, doing {%& title .. '!' %} (without title set) results in attempt to concatenate a nil value (global 'title') error.
There is no constraint on what values can be passed to a template, so any Lua value can be passed and then used inside a template.
In addition to the values that can be passed to templates, there are two special tables that provide access to cross-template values :
vars : provides access to values registered with setTemplateVar , andblock : provides access to template fragments that can be overwritten by other templates. Any value registered with setTemplateVar becomes accessible from any template through the vars table. In the following example, the vars.title value is set by the earlier setTemplateVar('title', 'World') call:
fm . setTemplateVar ( ' title ' , ' World ' )
fm . setTemplate ( " hello " , " Hello, {%& vars.title %}! " )
fm . render ( " hello " ) -- renders `Hello, World!` While undefined values are rendered as empty string by default (which may be convenient in most cases), there are still situations when it is preferrable to not allow undefined values to be silently handled. In this a special template variable ( if-nil ) can be set to handle those cases to throw an error or to log a message. For example, the following code throws an error, as the missing value is undefined, which triggers if-nil handler:
fm . setTemplateVar ( ' if-nil ' , function () error " missing value " end )
fm . setTemplate ( " hello " , " Hello, {%& vars.missing %}! " )
fm . render ( " hello " ) -- throws "missing value" error Templates can be also rendered from other templates by using the render function, which is available in every template:
fm . setTemplate ( " hello " , " Hello, {%& title %}! " )
fm . setTemplate ( " header " , " <h1>{% render('hello', {title = title}) %}</h1> " )
---- -----------------------------└──────────────────────────────┘----------
fm . render ( " header " , { title = ' World ' }) -- renders `<h1>Hello, World!</h1>`There are no limits on how templates can be rendered from other templates, but no checks for loops are made either, so having circular references in template rendering (when a template A renders a template B, which in turn renders A again) is going to cause a Lua error.
It's worth noting that the render function doesn't return the value of the template it renders, but instead puts it directly into the output buffer.
This ability to render templates from other templates allows producing layouts of any complexity. There are two ways to go about it:
To dynamically choose the template to use at render time, the template name itself can be passed as a parameter:
fm . setTemplate ( " hello " , " Hello, {%& title %}! " )
fm . setTemplate ( " bye " , " Bye, {%& title %}! " )
fm . setTemplate ( " header " , " <h1>{% render(content, {title = title}) %}</h1> " )
fm . render ( " header " , { title = ' World ' , content = ' hello ' }) This example renders either <h1>Hello, World!</h1> or <h1>Bye, World!</h1> depending on the value of the content parameter.
Using blocks allows defining template fragments that can (optionally) be overwritten from other templates (usually called "child" or "inherited" templates). The following example demonstrates this approach:
fm . setTemplate ( " header " , [[
<h1>
{% function block.greet() %} -- define a (default) block
Hi
{% end %}
{% block.greet() %}, -- render the block
{%& title %}!
</h1>
]] )
fm . setTemplate ( " hello " , [[
{% function block.greet() %} -- overwrite the `header` block (if any)
Hello
{% end %}
{% render('header', {title=title}) %}!
]] )
fm . setTemplate ( " bye " , [[
{% function block.greet() %} -- overwrite the `header` block (if any)
Bye
{% end %}
{% render('header', {title=title}) %}!
]] )
-- normally only one of the three `render` calls is needed,
-- so all three are shown for illustrative purposes only
fm . render ( " hello " , { title = ' World ' }) -- renders <h1>Hello, World!</h1>
fm . render ( " bye " , { title = ' World ' }) -- renders `<h1>Bye, World!</h1>`
fm . render ( " header " , { title = ' World ' }) -- renders `<h1>Hi, World!</h1>` In this example the header template becomes the "layout" and defines the greet block with Hi as its content. The block is defined as a function in the block table with the content it needs to produce. It's followed by a call to the block.greet function to include its content in the template.
This is important to emphasize, as in addition to defining a block, it also needs to be called from the base/layout template at the point where it is expected to be rendered.
The hello template also defines block.greet function with a different content and then renders the header template. When the header template is rendered, it uses the content of the block.greet function as defined in the hello template. In this way, the child template "redefines" the greet block with its own content, inserting it into the appropriate place into the parent template.
It works the same way for the bye and header templates. There is nothing special about these "block" functions other than the fact that they are defined in the block table.
This concepts is useful for template composition at any depth. For example, let's define a modal template with a header and a footer with action buttons:
fm . setTemplate ( " modal " , [[
<div class="modal">
<div class="modal-title">
{% function block.modal_title() %}
Details
{% end %}
{% block.modal_title() %}
</div>
<div class="modal-content">
{% block.modal_content() %}
</div>
<div class="modal-actions">
{% function block.modal_actions() %}
<button>Cancel</button>
<button>Save</button>
{% end %}
{% block.modal_actions() %}
</div>
</div>
]] )Now, in a template that renders the modal, the blocks can be overwritten to customize the content:
fm . setTemplate ( " page " , [[
{% function block.modal_title() %}
Insert photo
{% end %}
{% function block.modal_content() %}
<div class="photo-dropzone">Upload photo here</div>
{% end %}
{% render('modal') %}
]] )This enables easily building composable layouts and components, such as headers and footers, cards, modals, or anything else that requires the ability to dynamically customize sections in other templates.
Here is an example to illustrate how nested blocks work together:
-- base/layout template
{ % function block . greet () % } -- 1. defines default "greet" block
Hi
{ % end % }
{ % block . greet () % } -- 2. calls "greet" block
-- child template
{ % function block . greet () % } -- 3. defines "greet" block
Hello
{ % end % }
{ % render ( ' base ' ) % } -- 4. renders "base" template
-- grandchild template
{ % function block . greet () % } -- 5. defines "greet" block
Bye
{ % end % }
{ % render ( ' child ' ) % } -- 6. renders "child" template In this example the "child" template "extends" the base template and any block.greet content defined in the child template is rendered inside the "base" template (when and where the block.greet() function is called). The default block.greet block doesn't need to be defined in the base template, but when it is present (step 1), it sets the content to be rendered (step 2) if the block is not overwritten in a child template and needs to be defined before block.greet function is called.
Similarly, block.greet in the child template needs to be defined before (step 3) the base template is rendered (step 4) to have a desired effect.
If one of the templates in the current render tree doesn't define the block, then the later defined block is going to be used. For example, if the grandchild template doesn't define the block in step 5, then the greet block from the child template is going to be used when the grandchild template is rendered.
If none of the block.greet functions is defined, then block.greet() fails (in the base template). To make the block optional , just check the function before calling. For example, block.greet and block.greet() .
In those cases where the "overwritten" block may still need to be rendered, it's possible to reference that block directly from the template that defines it, as shown in the following example:
fm . setTemplate ( " header " , [[
<h1>
{% function block.greet() %}
Hi
{% end %}
{% block.greet() %}, {%& title %}!
</h1>
]] )
fm . setTemplate ( " bye " , [[
{% block.header.greet() %},
{% function block.greet() %}
Bye
{% end %}
{% render('header', {title=title}) %}!
]] )
fm . render ( " bye " , { title = ' World ' }) -- renders `<h1>Hi, Bye, World!</h1>` In this case, {% block.header.greet() %} in the bye template renders the greet block from the header template. This only works with the templates that are currently being rendered and is intended to simulate the "super" reference (albeit with explicit template references). The general syntax of this call is block.<templatename>.<blockname>() .
As blocks are simply regular Lua functions, there are no restrictions on how blocks can be nested into other blocks or how blocks are defined relative to template fragments or other Lua statements included in the templates.
In addition to registering templates from a string, the templates can be loaded and registered from a file or a directory using the same setTemplate function, but passing a table with the directory and a list of mappings from file extensions to template types to load. For example, calling fm.setTemplate({"/views/", tmpl = "fmt"}) loads all *.tmpl files from the /views/ directory (and its subdirectories) and registers each of them as the fmt template, which is the default template type. Only those files that match the extension are loaded and multiple extension mappings can be specified in one call.
Each loaded template gets its name based on the full path starting from the specified directory: the file /views/hello.tmpl is registered as a template with the name "hello" (without the extension), whereas the file /views/greet/bye.tmpl is registered as a template with the name "greet/bye" (and this is the exact name to use to load the template).
There are two caveats worth mentioning, both related to the directory processing. The first one is related to the trailing slash in the directory name passed to setTemplate . It's recommended to provide one, as the specified value is used as a prefix, so if /view is specified, it's going to match both /view/ and /views/ directories (if present), which may or may not be the intended result .
The second caveat is related to how external directories are used during template search. Since redbean allows access to external directories when configured using the -D option or directory option (see Running application for details), there may be multiple locations for the same template available. The search for the template follows these steps:
setTemplate call); This allows to have a working copy of a template to be modified and processed from the file system (assuming the -D option is used) during development without modifying its copy in the archive.
Even though using fm.render is sufficient to get a template rendered, for consistency with other serve* functions, the library provides the serveContent function, which is similar to fm.render , but allows the action handler to complete after serving the content:
fm . setTemplate ( " hello " , " Hello, {%& name %} " )
fm . setRoute ( " /hello/:name " , function ( r )
return fm . serveContent ( " hello " , { name = r . params . name })
end ) There is also one subtle difference between render and serveContent methods that comes into play when serving static templates . It may be tempting to directly render a static template in response to a route with something like this:
fm . setTemplate ( " hello " , " Hello, World! " )
-- option 1:
fm . setRoute ( " /hello " , fm . render ( " hello " ))
---- ---------------------└─────┘-------- not going to work
-- option 2:
fm . setRoute ( " /hello " , fm . serveContent ( " hello " ))
---- ---------------------└───────────┘-- works as expected The first approach is not going to work, as the call to fm.render is going to be made when setRoute is called (and the route is only being set up) and not when a request is being handled. When the serveContent method is using (the second option), it's implemented in a way that delays the processing until the request is handled, thus avoiding the issue. If the template content depends on some values in the request, then the serverContent call has to be wrapped into a function to accept and pass those variables (as shown in the earlier /hello/:name route example).
Most of the time, the library configuration is focused on handling of incoming requests, but in some cases it may be desirable to trigger and handle internal events. The library supports job scheduling using cron syntax, with configured jobs executed at the scheduled time (as long as the redbean instance is running). A new schedule can be registered using the setSchedule method:
---- ----------- ┌─────────── minute (0-59)
---- ----------- │ ┌───────── hour (0-23)
---- ----------- │ │ ┌─────── day of the month (1-31)
---- ----------- │ │ │ ┌───── month (1-12 or Jan-Dec)
---- ----------- │ │ │ │ ┌─── day of the week (0-6 or Sun-Mon)
---- ----------- │ │ │ │ │ --
---- ----------- │ │ │ │ │ --
fm . setSchedule ( " * * * * * " , function () fm . logInfo ( " every minute " ) end )All the standard and some non-standard cron expressions are supported:
* : describes any values in the allowed range., : uses to form a list of items, for example, 1,2,3 .- : creates an (inclusive) range; for example, 1-3 is equivalent to 1,2,3 . Open ranges are allowed as well, so -3 is equivalent to 1-3 for months and 0-3 for minutes and hours./ : describes a step for ranges. It selects a subset of the values in the range, using the step value; for example, 2-9/3 is equivalent to 2,5,8 (it starts with 2, then adds a step value to get 5 and 8). Non-numeric values are supported for months ( Jan-Dec ) and days of week ( Sun-Mon ) in any capitalization. Using 7 for Sun is supported too.
By default all functions are executed in a separate (forked) process. If the execution within the same process is needed, then setSchedule can be passed a third parameter (a table) to set sameProc value as one of the options: {sameProc = true} .
Some of the caveats to be aware of:
OnServerHeartbeat hook, so a version of Redbean that provides that (v2.0.16+) should be used.and (instead of an or ), so when both are specified, the job is executed when both are satisfied (and not when both or either are specified). In other words, * * 13 * Fri is only valid on Friday the 13th and not on any Friday. If the or behavior is needed, then the schedule can be split into two to handle each condition separately.sameProc = true option to avoid forking.Sun available on both ends (as 0 or 7), so it's better to use closed ranges in this case to avoid ambiguity.6-100 for months is corrected to 6-12 .Each action handler generates some sort of response to send back to the client. In addition to strings, the application can return the following results:
serveResponse ),serveContent ),serveRedirect ),serveAsset ),serveError ),serveIndex ), andservePath ). Each of these methods can be used as the return value from an action handler. serveAsset , servePath , and serveIndex methods can also be used as action handlers directly:
fm . setRoute ( " /static/* " , fm . serveAsset )
fm . setRoute ( " /blog/ " , fm . serveIndex ( " /new-blog/ " )) The first route configures all existing assets to be served from /static/* location; the second route configures /blog/ URL to return the index ( index.lua or index.html resource) from /new-blog/ directory.
serveResponse(status[, headers][, body]) : sends an HTTP response using provided status , headers , and body values. headers is an optional table populated with HTTP header name/value pairs. If provided, this set of headers removes all other headers set earlier during the handling of the same request. Similar to the headers set using the request.headers field, the names are case-insensitive , but provided aliases for header names with dashes are case-sensitive : {ContentType = "foo"} is an alternative form for {["Content-Type"] = "foo"} . body is an optional string.
Consider the following example:
return fm . serveResponse ( 413 , " Payload Too Large " ) This returns the 413 status code and sets the body of the returned message to Payload Too Large (with the header table not specified).
If only the status code needs to be set, the library provides a short form using the serve### syntax:
return fm . serve413It can also be used as the action handler itself:
fm . setRoute ( fm . PUT " /status " , fm . serve402 ) serveContent(name, parameters) renders a template using provided parameters. name is a string that names the template (as set by a setTemplate call) and parameters is a table with template parameters (referenced as variables in the template).
Fullmoon's function makeStorage is a way to connect to, and use a SQLite3 database. makeStorage returns a database management table which contains a rich set of functions to use with the connected database.
The run method executes the configured application. By default the server is launched listening on localhost and port 8080. Both of these values can be changed by passing addr and port options:
fm . run ({ addr = " localhost " , port = 8080 }) The following options are supported; the default values are shown in parentheses and options marked with mult can set multiple values by passing a table:
addr : sets the address to listen on (mult)brand : sets the Server header value ( "redbean/v# fullmoon/v#" )cache : configures Cache-Control and Expires headers (in seconds) for all static assets served. A negative value disables the headers. Zero value means no cache.certificate : sets the TLS certificate value (mult)directory : sets local directory to serve assets from in addition to serving them from the archive within the executable itself (mult)headers : sets default headers added to each response by passing a table with HTTP header name/value pairslogMessages : enables logging of response headerslogBodies : enables logging of request bodies (POST/PUT/etc.)logPath : sets the log file path on the local file systempidPath : sets the pid file path on the local file systemport : sets the port number to listen on (8080)privateKey : sets the TLS private key value (mult)sslTicketLifetime : sets the duration (in seconds) of the ssl ticket (86400)trustedIp : configures IP address to trust (mult). This option accepts two values (IP and CIDR values), so they need to be passed as a table within a table specifying multiple parameters: trustedIp = {{ParseIp("103.31.4.0"), 22}, {ParseIp("104.16.0.0"), 13}}tokenBucket : enables DDOS protection. This option accepts zero to 5 values (passed as a table within a table); an empty table can be passed to use default values: tokenBucket = {{}} Each option can accept a simple value ( port = 80 ), a list of values ( port = {8080, 8081} ) or a list of parameters. Since both the list of values and the list of parameters are passed as tables, the list of values takes precedence, so if a list of parameters needs to be passed to an option (like trustedIp ), it has to be wrapped into a table: trustedIp = {{ParseIp("103.31.4.0"), 22}} . If only one parameter needs to be passed, then both trustedIp = {ParseIp("103.31.4.0")} and trustedIp = ParseIp("103.31.4.0") can work.
The key and certificate string values can be populated using the getAsset method that can access both assets packaged within the webserver archive and those stored in the file system.
There are also default cookie and session options that can be assigned using cookieOptions and sessionOptions tables described below.
cookieOptions sets default options for all cookie values assigned using request.cookie.name = value syntax ( {httponly=true, samesite="Strict"} ). It is still possible to overwrite default values using table assignment: request.cookie.name = {value, secure=false} .
sessionOptions sets default options for the session value assigned using request.session.attribute = value syntax ( {name="fullmoon_session", hash="SHA256", secret=true, format="lua"} ). If the secret value is set to true , then a random key is assigned each time the server is started ; if verbose logging is enabled (by either adding -v option for Redbean or by using fm.setLogLevel(fm.kLogVerbose) call), then a message is logged explaining how to apply the current random value to make it permanent.
Setting this value to false or an empty string applies hashing without a secret key.
The results shown are from runs in the same environment and on the same hardware as the published redbean benchmark (thanks to @jart for executing the tests!). Even though these tests are using pre-1.5 version of redbean and 0.10 version of Fullmoon, the current versions of redbean/Fullmoon are expected to deliver similar performance.
The tests are using exactly the same code that is shown in the introduction with one small change: using {%= name %} instead of {%& name %} in the template, which skips HTML escaping. This code demonstrates routing, parameter handling and template processing.
$ wrk -t 12 -c 120 http://127.0.0.1:8080/user/paul
Running 10s test @ http://127.0.0.1:8080/user/paul
12 threads and 120 connections
Thread Stats Avg Stdev Max +/- Stdev
Latency 312.06us 4.39ms 207.16ms 99.85%
Req/Sec 32.48k 6.69k 71.37k 82.25%
3913229 requests in 10.10s, 783.71MB read
Requests/sec: 387477.76
Transfer/sec: 77.60MB
The following test is using the same configuration, but redbean is compiled with MODE=optlinux option:
$ wrk -t 12 -c 120 http://127.0.0.1:8080/user/paul
Running 10s test @ http://127.0.0.1:8080/user/paul
12 threads and 120 connections
Thread Stats Avg Stdev Max +/- Stdev
Latency 346.31us 5.13ms 207.31ms 99.81%
Req/Sec 36.18k 6.70k 90.47k 80.92%
4359909 requests in 10.10s, 0.85GB read
Requests/sec: 431684.80
Transfer/sec: 86.45MB
The following two tests demonstrate the latency of the request handling by Fullmoon and by redbean serving a static asset (no concurrency):
$ wrk -t 1 -c 1 http://127.0.0.1:8080/user/paul
Running 10s test @ http://127.0.0.1:8080/user/paul
1 threads and 1 connections
Thread Stats Avg Stdev Max +/- Stdev
Latency 15.75us 7.64us 272.00us 93.32%
Req/Sec 65.54k 589.15 66.58k 74.26%
658897 requests in 10.10s, 131.96MB read
Requests/sec: 65241.45
Transfer/sec: 13.07MB
The following are the results from redbean itself on static compressed assets:
$ wrk -H 'Accept-Encoding: gzip' -t 1 -c 1 htt://10.10.10.124:8080/tool/net/demo/index.html
Running 10s test @ htt://10.10.10.124:8080/tool/net/demo/index.html
1 threads and 1 connections
Thread Stats Avg Stdev Max +/- Stdev
Latency 7.40us 1.95us 252.00us 97.05%
Req/Sec 129.66k 3.20k 135.98k 64.36%
1302424 requests in 10.10s, 1.01GB read
Requests/sec: 128963.75
Transfer/sec: 102.70MB
Berwyn Hoyt included Redbean results in his lua server benchmark results, which shows redbean outperforming a comparable nginx/openresty implementation.
Highly experimental with everything being subject to change.
The core components are more stable and have been rarely updated since v0.3. Usually, the documented interfaces are much more stable than undocumented ones. Those commits that modified some of the interfaces are marked with COMPAT label, so can be easily identified to review for any compatibility issues.
Some of the obsolete methods are still present (with a warning logged when used) to be removed later.
Paul Kulchenko ([email protected])
See LICENSE.
