feat: rrdoc

Author: bctnry

COUNT

@@ -1 +1 @@
-v0.1.6-alpha,104
+v0.1.6-alpha,142

docs/registration.org

@@ -0,0 +1,6 @@
+* user registration
+
+** terms of service and other similar stuff
+
+you must put them under the directory ~_rrdoc~ under your specified static assets directory for them to be available under the ~/rrdoc/{p}~ route; e.g. if your static assets directory is ~/opt/aegis/static~, then ~/rrdoc/toc.md~ would choose render the file ~/opt/aegis/static/_rrodc/toc.md~. (it's named "rrdoc" (reading-required documents) because these are not necessarily legal documents and can be very informal, e.g. code of conducts.)
+

pkg/aegis/config.go

@@ -64,6 +64,14 @@ type AegisConfig struct {
 	EmailConfirmationRequired bool `json:"emailConfirmationRequired"`
 	// when set to true, all registration must be screened by the webmaster.
 	ManualApproval bool `json:"requireManualApproval"`
+	// documents that users would have to read and agree to before
+	// registering a new account, e.g. terms of service. if "path"
+	// starts with "http://" or "https://", the path would be rendered
+	// as a link.  if it's not, it would be considered as na relpath to
+	// `$staticAssetDirectory/rrdoc`, e.g.  "Terms Of Service":
+	// "tos.md" links the file "$static/rrdoc/tos.md" to the title
+	// "Terms Of Service".
+	ReadingRequiredDocument []struct{Title string;Path string} `json:"readingRequiredDocument"`
 
 	// git-related config.
 	// NOTE(2025.12.30): we'll gradually move certain config options into here.
@@ -342,6 +350,13 @@ func (cfg *AegisConfig) Unlock() {
 	cfg.lock.Unlock()
 }
 
+func (cfg *AegisConfig) GetRRDocTitle(p string) string {
+	for _, v := range cfg.ReadingRequiredDocument {
+		if v.Path == p { return v.Title }
+	}
+	return ""
+}
+
 const (
 	OP_MODE_PLAIN = "plain"
 	OP_MODE_SIMPLE = "simple"

routes/controller/admin/init.go

@@ -3,6 +3,7 @@ package admin
 import (
 	"github.com/bctnry/aegis/routes"
 	"github.com/bctnry/aegis/routes/controller/admin/edit_user"
+	"github.com/bctnry/aegis/routes/controller/admin/rrdoc"
 )
 
 func BindAllAdminControllers(context *routes.RouterContext) {
@@ -14,6 +15,7 @@ func BindAllAdminControllers(context *routes.RouterContext) {
 	bindAdminReceiptSystemSettingController(context)
 	bindAdminUserListController(context)
 	edit_user.BindAdminEditUserController(context)
+	rrdoc.BindAdminRRDocController(context)
 	bindAdminNewUserController(context)
 	bindAdminNamespaceListController(context)
 	bindAdminEditNamespaceController(context)

routes/controller/init.go

@@ -23,6 +23,7 @@ func InitializeRoute(context *routes.RouterContext) {
 	bindShutdownNoticeController(context)
 	bindMaintenanceNoticeController(context)
 	bindPrivateNoticeController(context)
+	bindRRDocController(context)
 
 	if context.Config.UseNamespace {
 		bindNamespaceController(context)

routes/controller/register.go

@@ -76,6 +76,15 @@ func bindRegisterController(ctx *RouterContext) {
 				}))
 				return
 			}
+			if rc.Config.ReadingRequiredDocument != nil {
+				for i := range rc.Config.ReadingRequiredDocument {
+					if len(strings.TrimSpace(r.Form.Get(fmt.Sprintf("req-%d", i)))) <= 0 {
+						rc.ReportRedirect("/reg", 5, "Field Required", "You must consent to all the required documents.", w, r)
+						return
+					}
+				}
+			}
+			
 			password := r.Form.Get("password")
 			passwordHash, err := bcrypt.GenerateFromPassword([]byte(password), bcrypt.DefaultCost)
 			if err != nil {

templates/_footer.template.html

@@ -1,6 +1,6 @@
 
 {{define "_footer"}}
 <div class="footer-message">
-    Powered by <a href="https://github.com/AegisCodeForge/aegis">Aegis</a>, version v0.1.6-alpha (v0.1.6-alpha.build_104)
+    Powered by <a href="https://github.com/AegisCodeForge/aegis">Aegis</a>, version v0.1.6-alpha (v0.1.6-alpha.build_142)
 </div>
 {{end}}

templates/admin/_admin-sidebar.template.html

@@ -7,6 +7,7 @@
   <a class="admin-sidebar-item" href="/admin/rs-setting">Receipt system config</a>
   <a class="admin-sidebar-item" href="/admin/mailer-setting">Mailer config</a>
   <a class="admin-sidebar-item" href="/admin/site-lockdown">Site lockdown</a>
+  <a class="admin-sidebar-item" href="/admin/rrdoc">Legal documents config</a>
 
   <hr />
   <a class="admin-sidebar-item" href="/admin/user-list">Users</a>

templates/registration.template.html

@@ -44,6 +44,17 @@ <h1 class="header-name">Registration</h1>
 			  <td><textarea id="ta-reason" name="ta-reason"></textarea></td>
 			</tr>
 			{{end}}
+			{{if .Config.ReadingRequiredDocument}}
+			{{range $k, $v := .Config.ReadingRequiredDocument}}
+			<tr class="field">
+			  <td></td>
+			  <td>
+				<input style="display: inline" class="field-chkbox" type="checkbox" name="req-{{$k}}" id="chk-req-{{$k}}" />
+				<label for="chk-req-{{$k}}">I have read the content of <a target="_blank" href="{{getRRDocHref $v.Path}}">{{$v.Title}}</a> and consent to its terms</label>
+			  </td>
+			</tr>
+			{{end}}
+			{{end}}
 			<tr class="field">
 			  <td></td>
 			  <td><input class="form-submit" type="submit" value="Register" /></td>