add invite-only and private data, clean up readme, change from MIT to BSD 3-clause

.gitignore

···
-# binaries
-main
-clockwork
-beep
-*.exe
-*.exe~
-*.so
-*.dylib
-*.dll
-bin/
+# Binaries
+/beep
+/build/
 
-# editor/system specific metadata
+# Editor/system specific metadata
 .DS_Store
-.idea/
 .vscode/
-*.iml
 
-# secrets
+# Secrets
 /config.real.maple
 .env
 
-# local v and clockwork install (from gitpod stuffs)
+# Local V and Clockwork install (Gitpod)
+/clockwork
 /v/
 /clockwork/
 
-# quick notes i keep while developing
+# Quick notes I keep while developing
 /stickynote.md

config.maple

···
 
 	// set this to '' if your instance is closed source (twt)
 	source = 'https://github.com/emmathemartian/beep'
+
+	// toggle to `true` to require that users have an invite code to register
+	invite_only = false
+	invite_code = ''
+
+	// toggle to `true` to allow any non-logged-in user to view data (posts, users, etc)
+	public_data = false
 }
 
 http = {

license

···
+Copyright 2025 Emmeline Coats
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors
+   may be used to endorse or promote products derived from this software
+   without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

license.txt

···
-Copyright 2024 EmmaTheMartian
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

readme

···
+
+beep
+====
+
+> *a legendary land of lowercase lovers.*
+
+A self-hosted "social-media-oriented" mini-blogger.
+
+Technically made because I wanted to mess around with RSS,
+but I also wanted a teensy little blog/slow-paced-chat-app
+for myself and my friends.
+
+hosting
+-------
+
+You'll need a PostgreSQL database somewhere, along with V
+to compile beep:
+
+$ git clone https://github.com/emmathemartian/beep
+$ cd beep
+$ v -prod .
+
+Copy the `config.maple` as `config.real.maple`
+
+$ cp config.maple config.real.maple
+
+Edit `config.real.maple` to set the URL, port, DB username,
+password, and name.
+
+`config.real.maple` also has settings to configure the
+default theme, post length, username length, welcome
+messages, etc etc.
+
+WARNING: DO NOT PUT SECRETS IN `config.maple`.
+`config.maple` is intended to be pushed to Git as a
+"template config." Instead, use `config.real.maple` if you
+plan to push anywhere. It's gitignored by default, i.e, an
+accidental exclusion in the gitignore and push won't expose
+your keys.
+
+$ ./beep config.real.maple
+
+Then go to the configured port to view (default is
+`http://localhost:8008`).
+
+If you don't have a database, you can either self-host a
+psql database on your machine, or you can find a free one
+online. I like [neon.tech](https://neon.tech), their free
+plan is pretty comfortable for a small beep instance!

readme.md

···
-# beep
-
-> *a legendary land of lowercase lovers.*
-
-a self-hosted "social-media-oriented" mini-blogger.
-
-technically made because i wanted to mess around with rss, but i also wanted a
-teensy little blog/slow-paced-chat-app for myself and my friends.
-
-## hosting
-
-you will need a postgresql database somewhere, along with v to compile beep:
-
-copy the `config.maple` as `config.real.maple`
-
-edit `config.real.maple` to set the url, port, username, password, and database
-name.
-
-> `config.real.maple` also has settings to configure the feel of your beep
-> instance, post length, username length, welcome messages, etc etc.
-
-> **do not put your secrets in `config.maple`**. it is intended to be pushed to
-> git as a "template config." instead, use `config.real.maple` if you plan to
-> push anywhere. it is gitignored already, meaning you do not have to fear about
-> your secrets not being kept a secret.
-
-```sh
-git clone https://github.com/emmathemartian/beep
-cd beep
-v -prod .
-./beep config.real.maple
-```
-
-then go to the configured url to view (default is `http://localhost:8008`).
-
-if you do not have a database, you can either self-host a postgresql database on
-your machine, or you can find a free one online. i use and like
-[neon.tech](https://neon.tech), their free plan is pretty comfortable for a
-small beep instance!

src/templates/partial/header.html

···
 <!DOCTYPE html>
-<html>
+<html lang="en">
 
 <head>
 	<meta charset="utf-8" />
+	<meta name="viewport" content="width=device-width, initial-scale=1" />
 	<meta name="description" content="" />
+
 	<link rel="icon" href="/favicon.png" />
-	<meta name="viewport" content="width=device-width, initial-scale=1" />
 	<title>@ctx.title</title>
 
 	@include 'assets/style.html'

src/templates/register.html

···
 			required
 		>
 		<br>
+		@if app.config.instance.invite_only
+		<label for="invite-code">invite code:</label>
+		<input type="text" name="invite-code" id="invite-code" required>
+		<br>
+		@end
 		@if app.config.hcaptcha.enabled
 		<div class="h-captcha" data-sitekey="@{app.config.hcaptcha.site_key}"></div>
 		<script src="https://js.hcaptcha.com/1/api.js" async defer></script>

src/webapp/api.v

···
 // people from requesting searches with huge limits and straining the SQL server
 pub const search_hard_limit = 50
 
+////// util ///////
+
+const always_public_routes = [
+	'/api/user/register/',
+]
+
+fn (mut app App) public_data_check(mut ctx Context) ?veb.Result {
+	if !app.config.instance.public_data {
+		println(ctx.req.url)
+		if ctx.req.url in always_public_routes {
+			return none
+		}
+		_ := app.whoami(mut ctx) or {
+			ctx.error('not logged in')
+			return ctx.redirect('/login')
+		}
+	}
+	return none
+}
+
 ////// user //////
 
 struct HcaptchaResponse {
···
 			ctx.error('failed to verify hcaptcha: ${data}')
 			return ctx.redirect('/register')
 		}
+	}
+
+	if app.config.instance.invite_only && ctx.form['invite-code'] != app.config.instance.invite_code {
+		ctx.error('invalid invite code')
+		return ctx.redirect('/register')
 	}
 
 	if app.get_user_by_name(username) != none {
···
 	// validate
 	if clean_nickname != none && !app.validators.nickname.validate(clean_nickname or { '' }) {
 		ctx.error('invalid nickname')
-		return ctx.redirect('/me')
+		return ctx.redirect('/settings')
 	}
 
 	if !app.set_nickname(user.id, clean_nickname) {
 		eprintln('failed to update nickname for ${user} (${user.nickname} -> ${clean_nickname})')
-		return ctx.redirect('/me')
+		return ctx.redirect('/settings')
 	}
 
-	return ctx.redirect('/me')
+	return ctx.redirect('/settings')
 }
 
 @['/api/user/set_muted'; post]
···
 		ctx.error('failed to set automated status.')
 	}
 
-	return ctx.redirect('/me')
+	return ctx.redirect('/settings')
 }
 
 @['/api/user/set_theme'; post]
 fn (mut app App) api_user_set_theme(mut ctx Context, url string) veb.Result {
 	if !app.config.instance.allow_changing_theme {
 		ctx.error('this instance disallows changing themes :(')
-		return ctx.redirect('/me')
+		return ctx.redirect('/settings')
 	}
 
 	user := app.whoami(mut ctx) or {
···
 
 	if !app.set_theme(user.id, theme) {
 		ctx.error('failed to change theme')
-		return ctx.redirect('/me')
+		return ctx.redirect('/settings')
 	}
 
-	return ctx.redirect('/me')
+	return ctx.redirect('/settings')
 }
 
 @['/api/user/set_pronouns'; post]
···
 	clean_pronouns := pronouns.trim_space()
 	if !app.validators.pronouns.validate(clean_pronouns) {
 		ctx.error('invalid pronouns')
-		return ctx.redirect('/me')
+		return ctx.redirect('/settings')
 	}
 
 	if !app.set_pronouns(user.id, clean_pronouns) {
 		ctx.error('failed to change pronouns')
-		return ctx.redirect('/me')
+		return ctx.redirect('/settings')
 	}
 
-	return ctx.redirect('/me')
+	return ctx.redirect('/settings')
 }
 
 @['/api/user/set_bio'; post]
···
 	clean_bio := bio.trim_space()
 	if !app.validators.user_bio.validate(clean_bio) {
 		ctx.error('invalid bio')
-		return ctx.redirect('/me')
+		return ctx.redirect('/settings')
 	}
 
 	if !app.set_bio(user.id, clean_bio) {
 		eprintln('failed to update bio for ${user} (${user.bio} -> ${clean_bio})')
-		return ctx.redirect('/me')
+		return ctx.redirect('/settings')
 	}
 
-	return ctx.redirect('/me')
+	return ctx.redirect('/settings')
 }
 
 @['/api/user/get_name']
···
 
 @['/api/post/get_title']
 fn (mut app App) api_post_get_title(mut ctx Context, id int) veb.Result {
+	if !app.config.instance.public_data {
+		_ := app.whoami(mut ctx) or { return ctx.unauthorized('not logged in') }
+	}
 	post := app.get_post_by_id(id) or { return ctx.server_error('no such post') }
 	return ctx.text(post.title)
 }
···
 
 @['/api/post/get/<id>'; get]
 fn (mut app App) api_post_get_post(mut ctx Context, id int) veb.Result {
+	if !app.config.instance.public_data {
+		_ := app.whoami(mut ctx) or { return ctx.unauthorized('not logged in') }
+	}
 	post := app.get_post_by_id(id) or { return ctx.text('no such post') }
 	return ctx.json[Post](post)
 }
 
 @['/api/post/search'; get]
 fn (mut app App) api_post_search(mut ctx Context, query string, limit int, offset int) veb.Result {
+	_ := app.whoami(mut ctx) or { return ctx.unauthorized('not logged in') }
 	if limit >= search_hard_limit {
 		return ctx.text('limit exceeds hard limit (${search_hard_limit})')
 	}

src/webapp/config.v

···
 		allow_changing_theme bool
 		version              string
 		source               string
+		invite_only          bool
+		invite_code          string
+		public_data          bool
 	}
 	http        struct {
 	pub mut:
···
 	config.instance.allow_changing_theme = loaded_instance.get('allow_changing_theme').to_bool()
 	config.instance.version = loaded_instance.get('version').to_str()
 	config.instance.source = loaded_instance.get('source').to_str()
+	config.instance.invite_only = loaded_instance.get('invite_only').to_bool()
+	config.instance.invite_code = loaded_instance.get('invite_code').to_str()
+	config.instance.public_data = loaded_instance.get('public_data').to_bool()
 
 	loaded_http := loaded.get('http')
 	config.http.port = loaded_http.get('port').to_int()

src/webapp/pages.v

···
 import entity { User }
 
 fn (mut app App) index(mut ctx Context) veb.Result {
+	if !app.config.instance.public_data {
+		_ := app.whoami(mut ctx) or {
+			ctx.error('not logged in')
+			return ctx.redirect('/login')
+		}
+	}
+
 	ctx.title = app.config.instance.name
 	user := app.whoami(mut ctx) or { User{} }
 	recent_posts := app.get_recent_posts()
···
 
 @['/user/:username']
 fn (mut app App) user(mut ctx Context, username string) veb.Result {
+	if !app.config.instance.public_data {
+		_ := app.whoami(mut ctx) or {
+			ctx.error('not logged in')
+			return ctx.redirect('/login')
+		}
+	}
+
 	user := app.whoami(mut ctx) or { User{} }
 	viewing := app.get_user_by_name(username) or {
 		ctx.error('user not found')
···
 
 @['/post/:post_id']
 fn (mut app App) post(mut ctx Context, post_id int) veb.Result {
+	if !app.config.instance.public_data {
+		_ := app.whoami(mut ctx) or {
+			ctx.error('not logged in')
+			return ctx.redirect('/login')
+		}
+	}
+
 	post := app.get_post_by_id(post_id) or {
 		ctx.error('no such post')
 		return ctx.redirect('/')
···
 	mut replying_to_user := app.get_unknown_user()
 
 	if post.replying_to != none {
-		replying_to_post = app.get_post_by_id(post.replying_to) or {
-			app.get_unknown_post()
-		}
+		replying_to_post = app.get_post_by_id(post.replying_to) or { app.get_unknown_post() }
 		replying_to_user = app.get_user_by_id(replying_to_post.author_id) or {
 			app.get_unknown_user()
 		}