Final for CS370

.gitignore

@@ -10,9 +10,15 @@
 *.dll
 *.so
 *.dylib
+*.db
+*.sqlite3
 
 # Test binary, build with `go test -c`
 *.test
 
 # Output of the go coverage tool, specifically when used with LiteIDE
 *.out
+
+
+*.old
+

README.md

@@ -7,32 +7,31 @@ studying ability*
 
 ## Installing
 
+To run this project, `golang-go` and `git` must be installed on your system. They can both be downloaded using the
+command:
+```bash
+sudo apt install golang-go git -y
+```
+
 Download the source using the command:
 
 ```bash
 git clone https://github.com/SocialHW/HomeworkHub.git
 ``` 
 
-Installing the required dependencies to run (such as MySQL):
-
+Running this project no longer requires any external dependencies to be running, such as MySQL. However, you must 
+install the third party libraries we are using for our cryptographic functions, and for interacting with our 
+SQLite3 database. To do so, run the command:
 ```bash
-cd HomeworkHub/
-sh init/init.sh
+go get golang.org/x/crypto/bcrypt github.com/mattn/go-sqlite3
 ```
 
 ## Building and Running
 
-The project depends on the existence of a local instance of MySQL running. To start MySQL after it is installed, 
-run the command:
-
-```bash
-sh init/start_db.sh
-```
-
 To run the project as a Go script, simply run this command from the root directory of the project:
 
 ```bash
-go run main.go
+go run *.go
 ```
 
 
@@ -56,4 +55,4 @@ git flow feature start <feature-name>
 This will create a new branch named `feature/<feature-name>`, and checkout that branch so you can immediately start work
 on it. When the feature is finished and you would like to merge, make sure you have commited and pushed all of your
 changes, and head to GitHub where you can make a new pull request for that feature. Make sure to merge into the develop
-branch.
+branch.

db/comment_section.go

@@ -0,0 +1,13 @@
+package main
+
+import (
+	"database/sql"
+
+	_ "github.com/mattn/go-sqlite3"
+)
+
+func main() {
+	database, _ := sql.Open("sqlite3", "./db.sqlite3")
+	statement, _ := database.Prepare("CREATE TABLE IF NOT EXISTS comment_section (post_id INTEGER, username TEXT, comment TEXT)")
+	statement.Exec()
+}

db/post_info.go

@@ -0,0 +1,13 @@
+package main
+
+import (
+	"database/sql"
+
+	_ "github.com/mattn/go-sqlite3"
+)
+
+func main() {
+	database, _ := sql.Open("sqlite3", "./db.sqlite3")
+	statement, _ := database.Prepare("CREATE TABLE IF NOT EXISTS post_info (post_id INTEGER PRIMARY KEY AUTOINCREMENT, username TEXT, title TEXT, file_path TEXT)")
+	statement.Exec()
+}

db/user_info.go

@@ -0,0 +1,13 @@
+package main
+
+import (
+	"database/sql"
+
+	_ "github.com/mattn/go-sqlite3"
+)
+
+func main() {
+	database, _ := sql.Open("sqlite3", "./db.sqlite3")
+	statement, _ := database.Prepare("CREATE TABLE IF NOT EXISTS userInfo (id INTEGER PRIMARY KEY AUTOINCREMENT, username TEXT, password TEXT)")
+	statement.Exec()
+}

design_artifacts/account-creation.md

@@ -0,0 +1,16 @@
+###Account Creation
+
+Users will be able to create an account by clicking a link in the top right corner of 
+the home page with the text "Register". The link will direct the user to /register where 
+they can provide a username, and a password. They submit the request to create an 
+account by pressing a button labeled "Create Account". If the username is not taken, they
+will be redirected to the index page. From there they can continue to login by clicking 
+a link in the top right corner with the text "Login". From there they can enter the 
+username and password they provided before. They will be redirected to the index page,
+where they will now be logged in.
+
+When the user clicks on the Create Account button, they will be submitting an HTTP POST
+request, to /register/details with the information they provided. There will be a 
+handler function listening on /register/details which will query the user info table
+to find an account with a matching username. If there is no account with a matching 
+username, the account can be created by inserting a new row into the database. 

design_artifacts/database_communication.md

@@ -0,0 +1,13 @@
+###Database Communication
+
+We should have a file at the db directory of the project that contains all of the functions needed to interact with the 
+database.
+* There should be a RegisterUser function that will take the email and password as strings, and executes the queries to 
+insert the user into the database if it is a valid registration.
+* There should be a LoginUser function that will take a username and password as strings, query the database to for the 
+password associated with the username entered. If the username exists and the password entered is equal to the password 
+in the database, the user is redirected to the home page.  
+* There should be a GetPosts function that takes a predicate function (of Post -> Boolean) and returns []Post, 
+containing the Posts in the database that meet the predicate. Future implementations may use a comparator function to 
+rank the results, such as closest search result match.
+* There should be a CreatePost function, that takes a Post struct and inserts all of its fields into. 

design_artifacts/database_design.md

@@ -0,0 +1,20 @@
+###Database Structure
+
+SQLite uses a .db file to represent the database. We should have some .db file located in the db directory. This file 
+will contain all of the tables we use to store information related to the site.
+___
+
+There should be a Posts table with the following columns:
+
+post_id primary key, auto inc INTEGER | username TEXT | title TEXT | extension TEXT 
+___
+
+There should be a Comments table with the following columns:
+
+post_id INTEGER | username TEXT | comment TEXT
+___
+
+There should be a user info table with the following columns:
+
+ID primary key, auto inc INTEGER | Username TEXT | password TEXT 
+___

design_artifacts/feedback_mechanism.md

@@ -0,0 +1,5 @@
+###Feedback Mechanism
+
+We were planning on creating some sort of rating system in order to show users more 
+relevant and higher quality results. We have since abandoned this idea for the sake of
+time.

design_artifacts/file_uploading.md

@@ -0,0 +1,13 @@
+###File Uploading
+
+Uploading images to the site represent the core value of the project. Users will have the ability to upload jpg/jpeg, 
+png, gif, and pdf files to be stored on the site. There will be a maximum upload size of 8MB in order to restrict users
+from overusing the resources of the web server. Each file will be associated with a post, which is a row in the Posts
+table containing information such as the user who created the post, the title, and the extension of the file. The file
+will be saved in the location "posts/<postid>.<ext>". Since each post will have a unique ID, this will prevent
+collisions when storing files on the disk.
+
+In order to create a new post, a user must be logged in and will click a link in the top right corner of the web page.
+The user will be redirected to /create-post, where they will be prompted for the information required for a new post.
+
+It should not be allowed to use punctuation such as ;, in order to avoid SQL injection.

design_artifacts/post_searching.md

@@ -0,0 +1,9 @@
+###Post Searching
+
+In order to aid users in navigating the site, we will provide a searching feature. There
+will be a text box located in the header of the page, where users (who do not need to be
+logged in) can enter a string of text and hit enter to see the results. The search will
+return results that include any of the words in the query in the title, and present
+them in a vertical listing. 
+
+It should not be allowed to use punctuation such as ;, in order to avoid SQL injection.