Use router package instead of GET parameter for manage pages

Author: Eggbertx

README.md

@@ -13,7 +13,7 @@ Demo installation: https://gochan.org
 3. If you're using nginx, copy gochan-http.nginx, or gochan-fastcgi.nginx if `UseFastCGI` is set to true to /etc/nginx/sites-enabled/, or the appropriate folder in Windows.
 4. If you're using a Linux distribution with systemd, you can optionally copy gochan.service to /lib/systemd/system/gochan.service and run `systemctl enable gochan.service` to have it run on startup. Then run `systemctl start gochan.service` to start it as a background service.
 	1. If you aren't using a distro with systemd, you can start a screen session and run `/path/to/gochan`
-5. Go to http://[gochan url]/manage?action=staff, log in (default username/password is admin/password), and create a new admin user (and any other staff users as necessary). Then delete the admin user for security.
+5. Go to http://[gochan url]/manage/staff, log in (default username/password is admin/password), and create a new admin user (and any other staff users as necessary). Then delete the admin user for security.
 
 ## Installation using Docker
 See [`docker/README.md`](docker/README.md)

build.py

@@ -366,7 +366,7 @@ def install(prefix="/usr", document_root="/srv/gochan", symlinks=False, js_only=
 	print(
 		"gochan was successfully installed. If you haven't already, you should copy\n",
 		"sample-configs/gochan.example.json to /etc/gochan/gochan.json (modify as needed)\n",
-		"You may also need to go to https://yourgochansite/manage?action=rebuildall to rebuild the javascript config")
+		"You may also need to go to https://yourgochansite/manage/rebuildall to rebuild the javascript config")
 	if gcos == "linux":
 		print(
 			"If your Linux distribution has systemd, you will also need to run the following commands:\n",

cmd/gochan-migration/main.go

@@ -21,7 +21,7 @@ the README and/or the -h command line flag before you use it.
 	migrateCompleteTxt = `Database migration successful!
 To migrate the uploads for each board, move or copy the uploads to /path/to/gochan/document/root/<boardname>/src/
 Then copy the thumbnails to /path/to/gochan/documentroot/<boardname>/thumb/
-Then start the gochan server and go to http://yoursite/manage?action=rebuildall to generate the html files
+Then start the gochan server and go to http://yoursite/manage/rebuildall to generate the html files
 for the threads and board pages`
 
 	allowedDirActions = "Valid values are noaction, copy, and move (defaults to noaction if unset)"

cmd/gochan/server.go

@@ -10,6 +10,8 @@ import (
 	"strconv"
 	"strings"
 
+	"github.com/uptrace/bunrouter"
+
 	"github.com/gochan-org/gochan/pkg/config"
 	"github.com/gochan-org/gochan/pkg/gcutil"
 	"github.com/gochan-org/gochan/pkg/manage"
@@ -18,14 +20,10 @@ import (
 )
 
 var (
-	server *gochanServer
+	router *bunrouter.Router
 )
 
-type gochanServer struct {
-	namespaces map[string]func(http.ResponseWriter, *http.Request)
-}
-
-func (s gochanServer) serveFile(writer http.ResponseWriter, request *http.Request) {
+func serveFile(writer http.ResponseWriter, request *http.Request) {
 	systemCritical := config.GetSystemCriticalConfig()
 	siteConfig := config.GetSiteConfig()
 
@@ -56,7 +54,7 @@ func (s gochanServer) serveFile(writer http.ResponseWriter, request *http.Reques
 			return
 		}
 	}
-	s.setFileHeaders(filePath, writer)
+	setFileHeaders(filePath, writer)
 
 	// serve the requested file
 	fileBytes, _ = os.ReadFile(filePath)
@@ -65,7 +63,7 @@ func (s gochanServer) serveFile(writer http.ResponseWriter, request *http.Reques
 }
 
 // set mime type/cache headers according to the file's extension
-func (*gochanServer) setFileHeaders(filename string, writer http.ResponseWriter) {
+func setFileHeaders(filename string, writer http.ResponseWriter) {
 	extension := strings.ToLower(path.Ext(filename))
 	switch extension {
 	case ".png":
@@ -102,16 +100,6 @@ func (*gochanServer) setFileHeaders(filename string, writer http.ResponseWriter)
 	}
 }
 
-func (s gochanServer) ServeHTTP(writer http.ResponseWriter, request *http.Request) {
-	for name, namespaceFunction := range s.namespaces {
-		if request.URL.Path == config.WebPath(name) {
-			namespaceFunction(writer, request)
-			return
-		}
-	}
-	s.serveFile(writer, request)
-}
-
 func initServer() {
 	systemCritical := config.GetSystemCriticalConfig()
 	siteConfig := config.GetSiteConfig()
@@ -124,8 +112,9 @@ func initServer() {
 			Int("Port", systemCritical.Port).Send()
 		fmt.Printf("Failed listening on %s:%d: %s", systemCritical.ListenIP, systemCritical.Port, err.Error())
 	}
-	server = new(gochanServer)
-	server.namespaces = make(map[string]func(http.ResponseWriter, *http.Request))
+	router = bunrouter.New(
+		bunrouter.WithNotFoundHandler(bunrouter.HTTPHandlerFunc(serveFile)),
+	)
 
 	// Check if Akismet API key is usable at startup.
 	err = serverutil.CheckAkismetAPIKey(siteConfig.AkismetAPIKey)
@@ -135,22 +124,21 @@ func initServer() {
 		fmt.Println("Got error when initializing Akismet spam protection, it will be disabled:", err)
 	}
 
-	server.namespaces["captcha"] = posting.ServeCaptcha
-	server.namespaces["manage"] = manage.CallManageFunction
-	server.namespaces["post"] = posting.MakePost
-	server.namespaces["util"] = utilHandler
-	server.namespaces["example"] = func(writer http.ResponseWriter, request *http.Request) {
-		if writer != nil {
-			http.Redirect(writer, request, "https://www.youtube.com/watch?v=dQw4w9WgXcQ", http.StatusFound)
-		}
-	}
+	router.GET(config.WebPath("/captcha"), bunrouter.HTTPHandlerFunc(posting.ServeCaptcha))
+	router.POST(config.WebPath("/captcha"), bunrouter.HTTPHandlerFunc(posting.ServeCaptcha))
+	router.GET(config.WebPath("/manage"), bunrouter.HTTPHandlerFunc(manage.CallManageFunction))
+	router.GET(config.WebPath("/manage/:action"), bunrouter.HTTPHandlerFunc(manage.CallManageFunction))
+	router.POST(config.WebPath("/manage/:action"), bunrouter.HTTPHandlerFunc(manage.CallManageFunction))
+	router.POST(config.WebPath("/post"), bunrouter.HTTPHandlerFunc(posting.MakePost))
+	router.GET(config.WebPath("/util"), bunrouter.HTTPHandlerFunc(utilHandler))
+	router.POST(config.WebPath("/util"), bunrouter.HTTPHandlerFunc(utilHandler))
 	// Eventually plugins might be able to register new namespaces or they might be restricted to something
 	// like /plugin
 
 	if systemCritical.UseFastCGI {
-		err = fcgi.Serve(listener, server)
+		err = fcgi.Serve(listener, router)
 	} else {
-		err = http.Serve(listener, server)
+		err = http.Serve(listener, router)
 	}
 
 	if err != nil {

devtools/selenium_testing/runtests.py

@@ -57,7 +57,7 @@ def gotoPage(driver: WebDriver, page: str):
 
 
 def isLoggedIn(driver: WebDriver):
-	gotoPage(driver, "manage?action=login")
+	gotoPage(driver, "manage/login")
 	return driver.find_element(by=By.CSS_SELECTOR, value="h1#board-title").text == "Dashboard"
 
 
@@ -177,7 +177,7 @@ def test_makeBoard(self):
 		if boardExists("seleniumtesting"):
 			raise Exception("Board /seleniumtests/ already exists")
 		loginToStaff(self.driver)
-		gotoPage(self.driver, "manage?action=boards")
+		gotoPage(self.driver, "manage/boards")
 
 		# fill out the board creation form
 		self.driver.find_element(by=By.NAME, value="dir").\
@@ -197,7 +197,7 @@ def test_makeBoard(self):
 
 		makePostOnPage("seleniumtesting", self)
 
-		gotoPage(self.driver, "manage?action=boards")
+		gotoPage(self.driver, "manage/boards")
 		sel = Select(self.driver.find_element(by=By.ID, value="modifyboard"))
 		sel.select_by_visible_text("/seleniumtesting/ - Selenium testing")
 		self.driver.find_element(by=By.NAME, value="dodelete").click()
@@ -221,7 +221,7 @@ def test_makeThread(self):
 	def test_moveThread(self):
 		if not boardExists("test2"):
 			loginToStaff(self.driver)
-			gotoPage(self.driver, "manage?action=boards")
+			gotoPage(self.driver, "manage/boards")
 
 			# fill out the board creation form
 			self.driver.find_element(by=By.NAME, value="dir").\

frontend/README.md

@@ -31,7 +31,7 @@ If you want, you can install [Sass](https://sass-lang.com/install) to streamline
 
 To use sass, run `./build.py sass`. If you want to minify the created css files, use the `--minify` flag. If you want sass to watch the input directory for changes as you edit and save the files, use the `--watch` flag.
 
-If you are upgading from gochan 2.2, delete your html/css directory unless you have made themes that you want to keep. Then rebuild the pages. (/manage?action=rebuildall)
+If you are upgading from gochan 2.2, delete your html/css directory unless you have made themes that you want to keep. Then rebuild the pages. (/manage/rebuildall)
 
 ## Attribution
 The BunkerChan, Clear, and Dark themes come from the imageboard BunkerChan. Burichan is based on the theme with the same name from Kusaba X. Photon comes from nol.ch (I think?) that as far as I know no longer exists. Pipes was created by a user (Mbyte?) on Lunachan (defunct). Yotsuba and Yotsuba B are based on the themes with the same names from 4chan.

frontend/js/dom/postdropdown.js

@@ -157,7 +157,7 @@ function handleActions(action, postIDStr) {
 		// manage stuff
 		case "Posts from this IP":
 			getPostInfo(postID).then(info => {
-				window.open(`${webroot}manage?action=ipsearch&limit=100&ip=${info.ip}`);
+				window.open(`${webroot}manage/ipsearch?limit=100&ip=${info.ip}`);
 			}).catch(reason => {
 				alertLightbox(`Failed getting post IP: ${reason.statusText}`, "Error");
 			});

frontend/js/management/filebans.js

@@ -4,7 +4,7 @@ import "jquery-ui/ui/unique-id";
 import "jquery-ui/ui/keycode";
 import "jquery-ui/ui/widgets/tabs";
 $(() => {
-	if(window.location.search.indexOf("?action=filebans") != 0)
+	if(window.location.pathname != webroot + "manage/filebans")
 		return;
 	$("div#fileban-tabs").tabs();
 });

frontend/js/management/manage.js

@@ -92,18 +92,15 @@ export function banFile(banType, filename, checksum, staffNote = "") {
 	}
 	return $.ajax({
 		method: "POST",
-		url: `${webroot}manage?action=filebans`,
+		url: `${webroot}manage/filebans`,
 		data: xhrFields
 	});
 }
 
 export async function initStaff() {
 	return $.ajax({
 		method: "GET",
-		url: `${webroot}manage`,
-		data: {
-			action: "actions"
-		},
+		url: `${webroot}manage/actions`,
 		async: true,
 		cache: false,
 		success: result => {
@@ -138,10 +135,7 @@ export async function getStaffInfo() {
 	loginChecked = true;
 	return $.ajax({
 		method: "GET",
-		url: `${webroot}manage`,
-		data: {
-			action: "staffinfo",
-		},
+		url: `${webroot}manage/staffinfo`,
 		async: true,
 		cache: true,
 		dataType: "json"
@@ -158,9 +152,8 @@ export async function getStaffInfo() {
 export async function getPostInfo(id) {
 	return $.ajax({
 		method: "GET",
-		url: `${webroot}manage`,
+		url: `${webroot}manage/postinfo`,
 		data: {
-			action: "postinfo",
 			postid: id
 		},
 		async: true,
@@ -191,7 +184,7 @@ export function banSelectedPost() {
 			break;
 		}
 	}
-	window.location = `${webroot}manage?action=bans&dir=${boardDir}&postid=${postID}`;
+	window.location = `${webroot}manage/bans?dir=${boardDir}&postid=${postID}`;
 }
 
 /**
@@ -201,7 +194,7 @@ export function banSelectedPost() {
 function menuItem(action, isCategory = false) {
 	return isCategory ? $("<div/>").append($("<b/>").text(action)) : $("<div/>").append(
 			$("<a/>").prop({
-				href: `${webroot}manage?action=${action.id}`
+				href: `${webroot}manage/${action.id}`
 			}).text(action.title)
 		);
 }
@@ -294,9 +287,8 @@ function updateReports(reports) {
 function getReports() {
 	return $.ajax({
 		method: "GET",
-		url: `${webroot}manage`,
+		url: `${webroot}manage/reports`,
 		data: {
-			action: "reports",
 			json: "1"
 		},
 		async: true,

frontend/js/management/sections.js

@@ -1,4 +1,4 @@
-// Make the sections table on /manage?action=boardsections sortable to make changing the list order easier
+// Make the sections table on /manage/boardsections sortable to make changing the list order easier
 
 /* global webroot */
 
@@ -28,7 +28,7 @@ function applyOrderChanges() {
 		let sectionhidden = $el.find(":nth-child(4)").html().toLowerCase() == "yes"?"on":"off";
 		$.ajax({
 			method: "POST",
-			url: webroot + "manage?action=boardsections",
+			url: webroot + "manage/boardsections",
 			data: {
 				updatesection: updatesection,
 				sectionname: sectionname,
@@ -81,7 +81,7 @@ function addButtons() {
 }
 
 $(() => {
-	if(window.location.search.indexOf("?action=boardsections") != 0)
+	if(window.location.pathname != webroot + "manage/boardsections")
 		return;
 
 	$sectionsTable = $("table#sections");

frontend/js/types/gochan.d.ts

@@ -91,7 +91,7 @@ declare interface ThreadPost {
 }
 
 /**
- * An object representing a staff member retreived by requesting /manage?action=staffinfo
+ * An object representing a staff member retreived by requesting /manage/staffinfo
  */
  interface StaffInfo {
 	/**
@@ -117,7 +117,7 @@ declare interface ThreadPost {
  */
 interface StaffAction {
 	/**
-	 * The GET key used when requesting /manage?action=<id>
+	 * The GET key used when requesting /manage/<id>
 	 */
 	id?:string;
 	/**
@@ -142,7 +142,7 @@ interface StaffAction {
 }
 
 /**
- * The result of requesting /manage?action=actions
+ * The result of requesting /manage/actions
  */
 declare var staffActions: StaffAction[];
 

frontend/package-lock.json

@@ -13,6 +13,7 @@ require (
 	github.com/tdewolff/minify v2.3.6+incompatible
 	github.com/tdewolff/parse v2.3.4+incompatible // indirect
 	github.com/tdewolff/test v1.0.7 // indirect
+	github.com/uptrace/bunrouter v1.0.19 // indirect
 	github.com/yuin/gopher-lua v0.0.0-20220504180219-658193537a64
 	golang.org/x/crypto v0.0.0-20220829220503-c86fa9a7ed90
 	golang.org/x/net v0.0.0-20220826154423-83b083e8dc8b

go.mod

@@ -4,6 +4,7 @@ github.com/chzyer/logex v1.1.10/go.mod h1:+Ywpsq7O8HXn0nuIou7OrIPyXbp3wmkHB+jjWR
 github.com/chzyer/readline v0.0.0-20180603132655-2972be24d48e/go.mod h1:nSuG5e5PlCu98SY8svDHJxuZscDgtXS6KTTbou5AhLI=
 github.com/chzyer/test v0.0.0-20180213035817-a1ea475d72b1/go.mod h1:Q3SI9o4m/ZMnBNeIyt5eFwwo7qiLfzFZmjNmxjkiQlU=
 github.com/coreos/go-systemd/v22 v22.3.3-0.20220203105225-a9a7ef127534/go.mod h1:Y58oyj3AT4RCenI/lSvhwexgC+NSVTIJ3seZv2GcEnc=
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/disintegration/imaging v1.6.2 h1:w1LecBlG2Lnp8B3jk5zSuNqd7b4DXhcjwek1ei82L+c=
 github.com/disintegration/imaging v1.6.2/go.mod h1:44/5580QXChDfwIclfc/PCwrr44amcmDAg8hxG0Ewe4=
 github.com/frustra/bbcode v0.0.0-20201127003707-6ef347fbe1c8 h1:sdIsYe6Vv7KIWZWp8KqSeTl+XlF17d+wHCC4lbxFcYs=
@@ -20,15 +21,20 @@ github.com/mattn/go-isatty v0.0.14/go.mod h1:7GGIvUiUoEMVVmxf/4nioHXj79iQHKdU27k
 github.com/mattn/go-sqlite3 v1.14.15 h1:vfoHhTN1af61xCRSWzFIWzx2YskyMTwHLrExkBOjvxI=
 github.com/mattn/go-sqlite3 v1.14.15/go.mod h1:2eHXhiwb8IkHr+BDWZGa96P6+rkvnG63S2DGjv9HUNg=
 github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/rs/xid v1.4.0/go.mod h1:trrq9SKmegXys3aeAKXMUTdJsYXVwGY3RLcfgqegfbg=
 github.com/rs/zerolog v1.28.0 h1:MirSo27VyNi7RJYP3078AA1+Cyzd2GB66qy3aUHvsWY=
 github.com/rs/zerolog v1.28.0/go.mod h1:NILgTygv/Uej1ra5XxGf82ZFSLk58MFGAUS2o6usyD0=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 github.com/tdewolff/minify v2.3.6+incompatible h1:2hw5/9ZvxhWLvBUnHE06gElGYz+Jv9R4Eys0XUzItYo=
 github.com/tdewolff/minify v2.3.6+incompatible/go.mod h1:9Ov578KJUmAWpS6NeZwRZyT56Uf6o3Mcz9CEsg8USYs=
 github.com/tdewolff/parse v2.3.4+incompatible h1:x05/cnGwIMf4ceLuDMBOdQ1qGniMoxpP46ghf0Qzh38=
 github.com/tdewolff/parse v2.3.4+incompatible/go.mod h1:8oBwCsVmUkgHO8M5iCzSIDtpzXOT0WXX9cWhz+bIzJQ=
 github.com/tdewolff/test v1.0.7 h1:8Vs0142DmPFW/bQeHRP3MV19m1gvndjUb1sn8yy74LM=
 github.com/tdewolff/test v1.0.7/go.mod h1:6DAvZliBAAnD7rhVgwaM7DE5/d9NMOAJ09SqYqeK4QE=
+github.com/uptrace/bunrouter v1.0.19 h1:kdN1Nl/9RDq9eBPnjS6GvNKcgiAeMxdb9DbpslLndFg=
+github.com/uptrace/bunrouter v1.0.19/go.mod h1:TwT7Bc0ztF2Z2q/ZzMuSVkcb/Ig/d3MQeP2cxn3e1hI=
 github.com/yuin/gopher-lua v0.0.0-20190206043414-8bfc7677f583/go.mod h1:gqRgreBUhTSL0GeU64rtZ3Uq3wtjOa/TB2YfrtkCbVQ=
 github.com/yuin/gopher-lua v0.0.0-20220504180219-658193537a64 h1:5mLPGnFdSsevFRFc9q3yYbBkB6tsm4aCwwQV/j1JQAQ=
 github.com/yuin/gopher-lua v0.0.0-20220504180219-658193537a64/go.mod h1:GBR0iDaNXjAgGg9zfCvksxSRnQx76gclCIb7kdAd1Pw=
@@ -56,5 +62,7 @@ golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
 golang.org/x/text v0.3.7 h1:olpwvP2KacW1ZWvsR7uQhoyTYvKAupfQrRGBFM352Gk=
 golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
 golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 layeh.com/gopher-luar v1.0.10 h1:55b0mpBhN9XSshEd2Nz6WsbYXctyBT35azk4POQNSXo=
 layeh.com/gopher-luar v1.0.10/go.mod h1:TPnIVCZ2RJBndm7ohXyaqfhzjlZ+OA2SZR/YwL8tECk=