Added documentation to code

Author: BumbleB-NL

sqlqueries.go

@@ -18,7 +18,10 @@ import (
 
 //Gets the env variable from the .env file, if none exist it will create one.
 func getEnvVariables(envname string) string {
+
+	//Checks if the .env file is present in the exe directory.
 	if _, err := os.Stat(".env"); err != nil {
+		//Creates a standard .env file in exe directory.
 		fmt.Println("No .env file found, creating a new one...")
 		envfile := "DB_USERNAME=\nDB_PASSWORD=\nDB_HOSTNAME=\nDB_TABLENAME="
 		os.Create(".env")
@@ -27,6 +30,7 @@ func getEnvVariables(envname string) string {
 		os.Exit(0)
 		return ""
 	} else {
+		//Loads the env with the specified key unless its empty and returns the value.
 		err = godotenv.Load(".env")
 		if err != nil {
 			panic(err)
@@ -50,30 +54,39 @@ func hash(username string, password string) (hash string) {
 
 //Opens a database connection using the configured env's, returns database connection.
 func SqlConnect() (db *sql.DB) {
+	//Gets the enviroment variables from the .env file.
 	usernameSQL := getEnvVariables("DB_USERNAME")
 	passwordSQL := getEnvVariables("DB_PASSWORD")
 	hostnameSQL := getEnvVariables("DB_HOSTNAME")
 	tablenameSQL := getEnvVariables("DB_TABLENAME")
+
+	//Starts a database connection using the enviroment variables from the .env.
 	db, err := sql.Open("mysql", usernameSQL+":"+passwordSQL+"@tcp("+hostnameSQL+")/"+tablenameSQL)
 	if err != nil {
 		panic(err)
 	}
 	return db
 }
 
+//Checks if the username or email exists in database.
 func sqlCheckIfExists(db *sql.DB, username string, email string) (userExists bool) {
 	getUsernameQuery := "SELECT Username FROM `users` WHERE Username = ?"
 	usernameSelect, err := db.Query(getUsernameQuery, username)
 	defer usernameSelect.Close()
 	if err != nil {
 		panic(err)
 	}
+
+	//Creates and executes SQL query from row Email Where Email is the email-adress entered by the user.
 	getEmailQuery := "SELECT Email FROM `users` WHERE Email = ?"
 	emailSelect, err := db.Query(getEmailQuery, email)
+
 	defer emailSelect.Close()
 	if err != nil {
 		panic(err)
 	}
+
+	//Scans the query results and translates them to strings, then checks if they are both empty.
 	var usernameSelectScan string
 	var emailSelectScan string
 	usernameSelect.Next()
@@ -89,9 +102,13 @@ func sqlCheckIfExists(db *sql.DB, username string, email string) (userExists boo
 
 //Registers the userdata into the database if the username and email are unique.
 func SqlRegister(db *sql.DB, username string, password string, email string) (allowRegister bool) {
+	//Checks if the username or email exists in the database.
 	if sqlCheckIfExists(db, username, email) {
+		//If it exists returns false
 		return false
+
 	} else {
+		//If it doesnt exist it creates and executes an SQL query to INSERT the new userdata into the database.
 		insertQuery := "INSERT INTO `users` (Username, Email, Authentication) VALUES (?, ?, ?)"
 		insert, err := db.Query(insertQuery, username, email, hash(username, password))
 		defer insert.Close()
@@ -105,17 +122,20 @@ func SqlRegister(db *sql.DB, username string, password string, email string) (al
 
 //Attempts to login the user with the username and password.
 func SqlLogin(db *sql.DB, username string, password string) (allowLogin bool) {
+	//Creates and executes SELECT Authentication from Users table Where username is the username entered by the user.
 	loginQuery := "SELECT Authentication FROM `users` WHERE Username = ?"
 	login, err := db.Query(loginQuery, username)
 	defer login.Close()
 	if err != nil {
 		return false
 	}
-	login.Next()
 
+	//Scans through the query results and saves it to a variable.
 	var passwordCheck string
+	login.Next()
 	login.Scan(&passwordCheck)
 
+	//Checks if the password entered by the user is the same as the hashed password that belongs to the username that was entered.
 	if hash(username, password) == passwordCheck {
 		return true
 	} else {
@@ -125,6 +145,7 @@ func SqlLogin(db *sql.DB, username string, password string) (allowLogin bool) {
 
 //Creates a random token for specified user.
 func SqlCreateToken(db *sql.DB, username string) (allowCreateToken bool) {
+	//Creates and executes SQL UPDATE Users table with a token that is generated from the username + unixtime for the user.
 	createTokenQuery := "UPDATE `users` SET Token = ? WHERE Username = ?"
 	rand.Seed(time.Now().UnixNano())
 	random := strconv.Itoa(rand.Intn(1000))
@@ -139,6 +160,7 @@ func SqlCreateToken(db *sql.DB, username string) (allowCreateToken bool) {
 
 //Deletes the token for the user.
 func SqlDeleteToken(db *sql.DB, username string) (allowDeleteToken bool) {
+	//UPDATE the Token row in Users table in sql to contain NULL effectively deleting the token.
 	deleteTokenQuery := "UPDATE `users` SET Token = NULL WHERE Username = ?"
 	delete, err := db.Query(deleteTokenQuery, username)
 	defer delete.Close()
@@ -151,6 +173,7 @@ func SqlDeleteToken(db *sql.DB, username string) (allowDeleteToken bool) {
 
 //Requests the token for the specified user from the database.
 func SqlGetToken(db *sql.DB, username string) (allowGetToken bool, tokenString string) {
+	//SELECTS Token FROM users table for the user and returns the token.
 	getTokenQuery := "SELECT Token FROM `users` WHERE Username = ?"
 	token, err := db.Query(getTokenQuery, username)
 	defer token.Close()