├── jsconfig.json ├── src ├── assets │ ├── fonts │ │ └── sk_indus_script-webfont.ttf │ ├── Logo-Black.svg │ └── Logo-White.svg ├── App.vue ├── components │ ├── icons │ │ ├── IconSupport.vue │ │ ├── IconTooling.vue │ │ ├── IconCommunity.vue │ │ ├── IconDocumentation.vue │ │ └── IconEcosystem.vue │ └── AppNavbar.vue ├── main.scss ├── main.js ├── router │ └── index.js ├── views │ ├── ContactView.vue │ ├── LoginView.vue │ ├── ProfileView.vue │ ├── HomeView.vue │ ├── SealView.vue │ ├── RegisterView.vue │ ├── SearchView.vue │ ├── DeciphermentView.vue │ └── AssignmentView.vue └── data │ └── usefulMaps.js ├── Dockerfile ├── local.env ├── .env ├── .gitignore ├── publish.sh ├── index.html ├── README.md ├── vite.config.js ├── package.json ├── run.sh ├── server.js └── LICENSE /jsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "allowJs": true 4 | } 5 | } 6 | -------------------------------------------------------------------------------- /src/assets/fonts/sk_indus_script-webfont.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yajnadevam/indus-website/HEAD/src/assets/fonts/sk_indus_script-webfont.ttf -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM alpine:latest 2 | RUN apk update && apk add nodejs npm 3 | 4 | WORKDIR ./harappa-app 5 | COPY package.json . 6 | RUN npm install 7 | COPY . . 8 | CMD NODE_ENV=production npm start 9 | -------------------------------------------------------------------------------- /local.env: -------------------------------------------------------------------------------- 1 | MYSQL_ROOT_HOST='localhost' 2 | MYSQLDB_USER='indususer' 3 | MYSQLDB_ROOT_PASSWORD='password123' 4 | MYSQLDB_DATABASE='induswebsite' 5 | MYSQLDB_DOCKER_PORT=3306 6 | NODE_DOCKER_PORT=3000 7 | -------------------------------------------------------------------------------- /.env: -------------------------------------------------------------------------------- 1 | MYSQL_ROOT_HOST='172.18.0.1' 2 | #MYSQL_ROOT_HOST='localhost' 3 | MYSQLDB_USER='indususer' 4 | MYSQLDB_ROOT_PASSWORD='password123' 5 | MYSQLDB_DATABASE='induswebsite' 6 | MYSQLDB_DOCKER_PORT=3306 7 | NODE_DOCKER_PORT=3000 8 | -------------------------------------------------------------------------------- /src/App.vue: -------------------------------------------------------------------------------- 1 | 5 | 6 | 15 | -------------------------------------------------------------------------------- /src/components/icons/IconSupport.vue: -------------------------------------------------------------------------------- 1 | 8 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | node_modules 3 | /dist 4 | 5 | # local env files 6 | .env.local 7 | .env.*.local 8 | 9 | # Log files 10 | npm-debug.log* 11 | yarn-debug.log* 12 | yarn-error.log* 13 | pnpm-debug.log* 14 | 15 | # Editor directories and files 16 | .idea 17 | .vscode 18 | *.suo 19 | *.ntvs* 20 | *.njsproj 21 | *.sln 22 | *.sw? 23 | 24 | db.config.js 25 | 26 | -------------------------------------------------------------------------------- /publish.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | docker build -t indus:latest --platform linux/amd64 . 3 | scp run.sh root@indusscript.info:/root 4 | ssh root@indusscript.info 'docker stop harappa && docker rm harappa' 5 | ssh root@indusscript.info docker rmi indus:latest 6 | docker save indus:latest | gzip | DOCKER_HOST=ssh://root@indusscript.info docker load 7 | ssh root@indusscript.info /root/run.sh -------------------------------------------------------------------------------- /index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | Indus 8 | 9 | 10 |
11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Sindhu Saraswati Website Project 2 | 3 | First, we must install MySQL, and ensure that it is correctly installed. 4 | Then run `mysql -u root -p yourRootPassword < population-script.sql`. 5 | 6 | Create a file called `db.config.js`. It should have this general format. 7 | 8 | ``` 9 | let config = { 10 | host: '127.0.0.1', 11 | user: 'indususer', 12 | password: 'password123', 13 | database: "induswebsite", 14 | }; 15 | 16 | module.exports = config; 17 | ``` 18 | 19 | Then, we can run it with `npm install && node server.js ` 20 | -------------------------------------------------------------------------------- /vite.config.js: -------------------------------------------------------------------------------- 1 | import { fileURLToPath, URL } from 'node:url' 2 | 3 | import { defineConfig } from 'vite' 4 | import vue from '@vitejs/plugin-vue' 5 | import Icons from 'unplugin-icons/vite' 6 | import IconsResolver from 'unplugin-icons/resolver' 7 | import Components from 'unplugin-vue-components/vite' 8 | 9 | // https://vitejs.dev/config/ 10 | export default defineConfig({ 11 | plugins: [ 12 | vue(), 13 | Components({ 14 | resolvers: [ 15 | IconsResolver({ 16 | prefix: "icons", 17 | enabledCollections: ['fa6-solid'], 18 | alias: { 19 | fas: "fa6-solid", 20 | }, 21 | }), 22 | ], 23 | }), 24 | Icons({ 25 | compiler: "vue3", 26 | }), 27 | ], 28 | resolve: { 29 | alias: { 30 | '@': fileURLToPath(new URL('./src', import.meta.url)) 31 | } 32 | } 33 | }) 34 | -------------------------------------------------------------------------------- /src/components/icons/IconTooling.vue: -------------------------------------------------------------------------------- 1 | 2 | 20 | -------------------------------------------------------------------------------- /src/components/icons/IconCommunity.vue: -------------------------------------------------------------------------------- 1 | 8 | -------------------------------------------------------------------------------- /src/main.scss: -------------------------------------------------------------------------------- 1 | @import "@inkline/inkline/css/variables"; 2 | @import "@inkline/inkline/css/mixins"; 3 | 4 | :root { 5 | --spacing: 1rem; 6 | --padding-top: 1rem; 7 | --padding-right: 1rem; 8 | --padding-bottom: 1rem; 9 | --padding-left: 1rem; 10 | 11 | --border-top-left-radius: 0.25rem; 12 | --border-top-right-radius: 0.25rem; 13 | --border-bottom-right-radius: 0.25rem; 14 | --border-bottom-left-radius: 0.25rem; 15 | 16 | --color--primary--h: 195deg; 17 | --color--primary--s: 77%; 18 | --color--primary--l: 39%; 19 | } 20 | 21 | .fade-enter-active, .fade-leave-active { 22 | transition: opacity 0.5s; 23 | } 24 | 25 | .fade-enter, .fade-leave-to { 26 | opacity: 0; 27 | } 28 | 29 | @include i-button() { 30 | ----padding-left: 2rem; 31 | ----padding-right: 2rem; 32 | 33 | @include variant("sm") { 34 | ----font-size: 10px; 35 | } 36 | 37 | @include variant("light") { 38 | ----background: white; 39 | } 40 | } 41 | 42 | @font-face { 43 | font-family: indus; 44 | src: url("./assets/fonts/sk_indus_script-webfont.ttf") format("truetype"); 45 | } 46 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "vue-project", 3 | "version": "0.0.0", 4 | "private": true, 5 | "scripts": { 6 | "dev": "vite", 7 | "build": "vite build", 8 | "preview": "vite preview" 9 | }, 10 | "dependencies": { 11 | "@inkline/inkline": "^3.2.2", 12 | "@vue/compiler-sfc": "^3.2.45", 13 | "axios": "^1.3.3", 14 | "bcryptjs": "^2.4.3", 15 | "body-parser": "^1.20.2", 16 | "dotenv": "^16.3.1", 17 | "eslint": "^8.38.0", 18 | "express": "^4.18.2", 19 | "mitt": "^3.0.0", 20 | "mysql2": "^3.2.0", 21 | "prettier": "^2.8.7", 22 | "primeflex": "~3.1.2", 23 | "primeicons": "~5.0.0", 24 | "primevue": "~3.12.2", 25 | "unplugin-vue-components": "^0.22.12", 26 | "vite-express": "0.3.1", 27 | "vue": "^3.2.45", 28 | "vue-eslint-parser": "^9.1.1", 29 | "vue-router": "^4.1.6", 30 | "vuex": "^4.1.0" 31 | }, 32 | "devDependencies": { 33 | "@iconify-json/fa6-solid": "^1.1.10", 34 | "@vitejs/plugin-vue": "^4.0.0", 35 | "pyright": "^1.1.292", 36 | "sass": "^1.57.1", 37 | "sass-loader": "^10.4.1", 38 | "sql-language-server": "^1.2.1", 39 | "unplugin-icons": "^0.15.1", 40 | "vite": "^4.5.0" 41 | } 42 | } 43 | -------------------------------------------------------------------------------- /src/components/icons/IconDocumentation.vue: -------------------------------------------------------------------------------- 1 | 8 | -------------------------------------------------------------------------------- /run.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | # 3 | source .env 4 | 5 | docker run --detach \ 6 | --name nginx-proxy \ 7 | --publish 80:80 \ 8 | --publish 443:443 \ 9 | --volume /etc/nginx/certs:/etc/nginx/certs \ 10 | --volume /etc/nginx/vhost.d:/etc/nginx/vhost.d \ 11 | --volume /var/www/html:/usr/share/nginx/html \ 12 | --volume /var/run/docker.sock:/tmp/docker.sock:ro \ 13 | nginxproxy/nginx-proxy 14 | 15 | docker run --detach \ 16 | --name nginx-proxy-acme \ 17 | --volumes-from nginx-proxy \ 18 | --volume /var/run/docker.sock:/var/run/docker.sock:ro \ 19 | --volume acme:/etc/acme.sh \ 20 | --env "DEFAULT_EMAIL=info@indusscript.info" \ 21 | nginxproxy/acme-companion 22 | 23 | docker run --detach \ 24 | --name mysqld \ 25 | --publish 172.18.0.1:3306:3306 \ 26 | -e MYSQL_ROOT_PASSWORD=$MYSQLDB_ROOT_PASSWORD \ 27 | -e MYSQL_DATABASE=$MYSQLDB_DATABASE \ 28 | -v db:/var/lib/mysql \ 29 | -v $(pwd)/population-script.sql:/docker-entrypoint-initdb.d/population-script.sql \ 30 | mysql:latest mysqld --mysqlx=0 31 | 32 | docker run --detach \ 33 | --name harappa \ 34 | --publish 172.18.0.1:3000:3000 \ 35 | -e DB_HOST=172.18.0.1 \ 36 | -e DB_USER=$MYSQLDB_USER \ 37 | -e DB_PASSWORD=$MYSQLDB_ROOT_PASSWORD \ 38 | -e DB_NAME=$MYSQLDB_DATABASE \ 39 | -e DB_PORT=$MYSQLDB_LOCAL_PORT \ 40 | -e NODE_ENV=production \ 41 | -e VIRTUAL_HOST=indusscript.info \ 42 | -e LETSENCRYPT_HOST=indusscript.info \ 43 | -e VIRTUAL_PORT=3000 \ 44 | indus:latest 45 | -------------------------------------------------------------------------------- /src/main.js: -------------------------------------------------------------------------------- 1 | import { createApp, h } from "vue"; 2 | import { createStore } from "vuex"; 3 | import mitt from "mitt"; 4 | import App from "./App.vue"; 5 | import router from "./router"; 6 | 7 | import { Inkline, components } from "@inkline/inkline"; 8 | import "@inkline/inkline/inkline.scss"; 9 | 10 | import "./main.scss"; 11 | 12 | //Event bus integration 13 | const emitter = mitt(); 14 | 15 | const store = createStore({ 16 | state() { 17 | return { 18 | user: null, 19 | userShown: false, 20 | searchRes: new Map(), 21 | }; 22 | }, 23 | mutations: { 24 | updateUser(state, newUser) { 25 | state.user = newUser; 26 | state.userShown = false; 27 | }, 28 | invertUserShown(state) { 29 | state.userShown = !state.userShown; 30 | }, 31 | updateSearchRes(state, newValue) { 32 | state.searchRes.set(newValue.query, newValue.res); 33 | } 34 | }, 35 | }); 36 | 37 | const app = createApp(App); 38 | 39 | app.use(router); 40 | 41 | app.use(Inkline, { 42 | components, 43 | colorMode: "system", 44 | }); 45 | 46 | app.use(store); 47 | app.config.globalProperties.emitter = emitter; 48 | 49 | app.component('transition', { 50 | setup(_, { slots }) { 51 | return () => h('transition', { 52 | enterActiveClass: 'fade-enter-active', 53 | enterFromClass: 'fade-enter', 54 | enterToClass: 'fade-enter-active', 55 | leaveActiveClass: 'fade-leave-active', 56 | leaveFromClass: 'fade-leave-to', 57 | leaveToClass: 'fade-leave-active', 58 | }, slots.default()) 59 | } 60 | }); 61 | 62 | app.mount("#app"); 63 | -------------------------------------------------------------------------------- /src/components/icons/IconEcosystem.vue: -------------------------------------------------------------------------------- 1 | 8 | -------------------------------------------------------------------------------- /src/router/index.js: -------------------------------------------------------------------------------- 1 | import { createRouter, createWebHistory } from "vue-router"; 2 | import HomeView from "../views/HomeView.vue"; 3 | import SearchView from "../views/SearchView.vue"; 4 | import LoginView from "../views/LoginView.vue"; 5 | import ContactView from "../views/ContactView.vue"; 6 | import RegisterView from "../views/RegisterView.vue"; 7 | import ProfileView from "../views/ProfileView.vue"; 8 | import SealView from "../views/SealView.vue"; 9 | import DeciphermentView from "../views/DeciphermentView.vue"; 10 | import AssignmentView from "../views/AssignmentView.vue"; 11 | 12 | const router = createRouter({ 13 | history: createWebHistory(import.meta.env.BASE_URL), 14 | routes: [ 15 | { 16 | path: "/", 17 | name: "home", 18 | component: HomeView, 19 | }, 20 | { 21 | path: "/contact", 22 | name: "contact", 23 | component: ContactView, 24 | }, 25 | { 26 | path: "/search", 27 | name: "search", 28 | component: SearchView, 29 | // route level code-splitting 30 | // this generates a separate chunk (About.[hash].js) for this route 31 | // which is lazy-loaded when the route is visited. 32 | // component: () => import("../views/SearchView.vue"), 33 | }, 34 | { 35 | path: "/login", 36 | name: "login", 37 | component: LoginView, 38 | }, 39 | { 40 | path: "/register", 41 | name: "register", 42 | component: RegisterView, 43 | }, 44 | { 45 | path: "/profile", 46 | name: "profile", 47 | component: ProfileView, 48 | }, 49 | { 50 | path: "/seal/:sealId", 51 | name: "seal", 52 | component: SealView, 53 | }, 54 | { 55 | path: "/decipherment", 56 | name: "decipherment", 57 | component: DeciphermentView, 58 | }, 59 | { 60 | path: "/assignment", 61 | name: "assignment", 62 | component: AssignmentView, 63 | } 64 | ], 65 | }); 66 | 67 | export default router; 68 | -------------------------------------------------------------------------------- /src/views/ContactView.vue: -------------------------------------------------------------------------------- 1 | 23 | 24 | 71 | 72 | 79 | -------------------------------------------------------------------------------- /src/data/usefulMaps.js: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | const qualityMap = new Map([ 5 | ["POT:T:g", "Pottery"], ["TAG", "Tag"], ["SEAL:S", "Seal"], 6 | ["SEAL:R", "Seal"], ["TAG:P", "Tag"], ["SEAL:C", "Seal"], 7 | ["MISC", "Misc."], ["TAB:I", "Tablet"], ["POT:T:s", "Pottery"], 8 | ["TAB:B", "Tablet"], ["ROD", "Rod"], ["BNGL", "Bangle"], 9 | ["SEAL:CY", "Seal"], ["IMPL", "Impression"], // Not too sure about this 10 | ["SEAL", "Seal"], ["Oth", "Other"], ["TAG:L", "Tag"], 11 | ["POT:T:p", "Pottery"], ["SEAL:L", "Seal"], ["TAG:O", "Tag"], 12 | ["TAG:B", "Tag"], ["TAG:W", "Tag"], ["TAG:C", "Tag"], 13 | ["TAB:C", "Tag"], ["TAG:R", "Tag"], ]); 14 | 15 | 16 | 17 | const symbolMap = new Map([ 18 | ["None", "None"], ["Bull", "Bull"], ["Bull1", "One-horned bull"], ["Bull1:J", "One-horned bull"], ["Bull1:II", "One-horned bull"], 19 | ["Rhin", "Rhinoceros"], ["Goat:1", "Goat"], ["Bull1:O", "One-horned bull"], ["Bull3", "Three-horned bull"], ["Buff", "Water buffalo"], 20 | ["Goat:4", "Goat"], ["Goat:3", "Goat"], ["Htgr", "Hunting tiger"], ["Bull1:W", "One-horned bull"], ["Bull1:V", "One-horned bull"], 21 | ["Elep", "Elephant"], ["Gaur", "Gaur"], ["nan", "Unknown"], ["Bull1:I", "One-horned bull"], ["Bull1:S", "One-horned bull"], 22 | ["T-A-T", "Tiger-attacking-tiger"], ["Bull1:L", "One-horned bull"], ["Tigr", "Tiger"], ["S590", "Unknown"], ["Fish", "Fish"], 23 | ["Bult", "Bull with hump"], ["Bull1:U", "One-horned bull"], ["Gavi", "Rhinoceros"], ["Pipal", "Pipal tree"], ["Tri4", "Three-fish motif"], 24 | ["Mult", "Unknown"], ["Zebu", "Zebu"], ["Goat", "Goat"], ["Phyt", "Tree"], ["Scene", "Unknown"], ["Bird", "Bird"], ["Bull2", "Two-horned bull"], 25 | ["Bull1:X", "One-horned bull"], ["CompBull", "Composite animal (bull)"], ["Othr", "Unknown"], ["Anth", "Anthropomorphic figure"], ["Turt", "Turtle"], 26 | ["Goat:2", "Goat"], ["Bull1:T", "One-horned bull"], ["Xhch", "Crosshatched square"], ["Comp", "Composite animal"], ["Misc", "Miscellaneous"], 27 | ["Crs", "Cross"], ["Cros", "Cross"], ["Unknown", "Unknown"], ["Goat:6", "Goat"], ["T-M-T", "Three-headed deity"], ["Xcrs", "Crossed rods"], 28 | ["Box", "Box"], ["Loop", "Looped object"], ["Hare", "Hare"], ["Goat:8", "Goat"], ["Goat:7", "Goat"], ["Gavi+Bult", "Rhinoceros and bull"], 29 | ["Maze", "Maze pattern"], ["Ass", "Ass"]]); 30 | 31 | 32 | export default { 33 | qualityMap, 34 | symbolMap 35 | } -------------------------------------------------------------------------------- /src/views/LoginView.vue: -------------------------------------------------------------------------------- 1 | 63 | 64 | 124 | 125 | 138 | -------------------------------------------------------------------------------- /src/views/ProfileView.vue: -------------------------------------------------------------------------------- 1 | 79 | 80 | 127 | 128 | 153 | -------------------------------------------------------------------------------- /src/views/HomeView.vue: -------------------------------------------------------------------------------- 1 | 15 | 16 | 125 | 126 | 127 | 143 | -------------------------------------------------------------------------------- /src/views/SealView.vue: -------------------------------------------------------------------------------- 1 | 72 | 73 | 128 | 129 | 155 | -------------------------------------------------------------------------------- /src/components/AppNavbar.vue: -------------------------------------------------------------------------------- 1 | 33 | 34 | 86 | 87 | 183 | -------------------------------------------------------------------------------- /src/views/RegisterView.vue: -------------------------------------------------------------------------------- 1 | 99 | 100 | 193 | 194 | 207 | -------------------------------------------------------------------------------- /src/views/SearchView.vue: -------------------------------------------------------------------------------- 1 | 86 | 87 | 144 | 145 | 172 | -------------------------------------------------------------------------------- /src/assets/Logo-Black.svg: -------------------------------------------------------------------------------- 1 | 2 | 4 | 5 | 10 | 140 | 141 | -------------------------------------------------------------------------------- /src/assets/Logo-White.svg: -------------------------------------------------------------------------------- 1 | 2 | 4 | 5 | 10 | 140 | 141 | -------------------------------------------------------------------------------- /src/views/DeciphermentView.vue: -------------------------------------------------------------------------------- 1 | 133 | 134 | 232 | 233 | -------------------------------------------------------------------------------- /src/views/AssignmentView.vue: -------------------------------------------------------------------------------- 1 | 134 | 135 | 233 | 234 | -------------------------------------------------------------------------------- /server.js: -------------------------------------------------------------------------------- 1 | const express = require("express"); 2 | const dns = require("dns"); 3 | const ViteExpress = require("vite-express"); 4 | const mysql = require("mysql2/promise"); 5 | const bodyParser = require("body-parser"); 6 | const bcrypt = require("bcryptjs"); 7 | // const {expect, it, test} = require("./lib/runner"); 8 | 9 | const app = express(); 10 | var jsonParser = bodyParser.json(); 11 | const salt = bcrypt.genSaltSync(10); 12 | 13 | if (process.env.NODE_ENV == 'production') { 14 | require('dotenv').config(); 15 | } else { 16 | require('dotenv').config({path: './local.env'}); 17 | } 18 | 19 | // Create a MySQL connection 20 | async function createConnection() { 21 | let config = { 22 | host: process.env.MYSQL_ROOT_HOST, 23 | user: process.env.MYSQLDB_USER, 24 | password: process.env.MYSQLDB_ROOT_PASSWORD, 25 | database: process.env.MYSQLDB_DATABASE, 26 | localAddress: process.env.NODE_DOCKER_PORT, 27 | port: process.env.MYSQLDB_DOCKER_PORT, 28 | } 29 | console.log(config); 30 | return mysql.createConnection(config); 31 | } 32 | 33 | async function userData(connection, username) { 34 | var queryRes = await connection.execute( 35 | "SELECT username,email,body,header,usertype FROM USER WHERE username = ?", 36 | [username] 37 | ); 38 | return queryRes[0][0]; 39 | } 40 | 41 | async function main() { 42 | var connection = await createConnection(); 43 | 44 | //test MySQL 45 | var [randomResults, randomFields] = await connection.execute( 46 | "SELECT * FROM USER WHERE RAND() < .3 LIMIT 1; " 47 | ); 48 | console.log( 49 | "A possible user's Login credentials are \nusername: " + 50 | randomResults[0].USERNAME + 51 | " \npassword: " + 52 | randomResults[0].PASSWORD 53 | ); 54 | 55 | // The below statement hashes all plaintext passwords in the db. 56 | await connection 57 | .query("SELECT USERNAME, PASSWORD FROM USER;", []) 58 | .then((queryArg) => { 59 | let queryResults = queryArg[0]; 60 | process.stdout.write("Hashing passwords..."); 61 | const updatePromises = queryResults.map((queryResult) => { 62 | return connection 63 | .query(`UPDATE USER SET HASHEDPASSWORD = ? WHERE USERNAME = ?;`, [ 64 | bcrypt.hashSync(queryResult["PASSWORD"], salt), 65 | queryResult["USERNAME"], 66 | ]) 67 | .catch(console.error); 68 | }); 69 | return Promise.all(updatePromises); 70 | }) 71 | .then(() => { 72 | console.log(" done"); 73 | }) 74 | .catch(console.error); 75 | 76 | //While we still keep the unhashed password, the rest of the code will use `hashedPassword` to verify the password. 77 | //The plaintext password is retained for debugging & testing purposes. 78 | //The hashing algorithm used is more secure, `bcrypt` prevents rainbow-table attacks 79 | //A disadvantage is that we cannot retrieve the hashed password back(we can only perform compare operations). 80 | //Hence I will still have to store the plaintext to debug for existing users. 81 | 82 | // Handle POST requests to the login endpoint 83 | app.post("/api/login", jsonParser, async (req, res) => { 84 | console.log(req.body); 85 | /* console.log(req); */ 86 | const username = req.body.username; 87 | const password = req.body.password; 88 | connection = await createConnection(); 89 | 90 | // Query the MySQL database for the user credentials 91 | connection 92 | .query("SELECT HASHEDPASSWORD FROM USER WHERE USERNAME = ?", [username]) 93 | .then((queryArg) => { 94 | results = queryArg[0]; 95 | if (results.length === 0) { 96 | console.log("No such users exist."); 97 | res.status(401).json({ message: "No such user exists" }); 98 | } else if ( 99 | !bcrypt.compareSync(password, results[0]["HASHEDPASSWORD"]) 100 | ) { 101 | console.log("Incorrect password entered."); 102 | res.status(401).json({ message: "Incorrect password entered" }); 103 | } else { 104 | // Return a success message 105 | console.log("Successful Login!"); 106 | userData(connection, username).then((user) => { 107 | console.log("user: " + JSON.stringify(user)); 108 | res.json({ message: "Login successful", user }); 109 | }); 110 | } 111 | }) 112 | .catch((error) => { 113 | if (error) { 114 | console.log("Error retrieving userdata!"); 115 | res.status(500).json({ error }); 116 | } 117 | }); 118 | }); 119 | 120 | // Handle POST requests to the register endpoint 121 | app.post("/api/register", jsonParser, async (req, res) => { 122 | console.log(req.body); 123 | /* console.log(req); */ 124 | const username = req.body.username; 125 | const email = req.body.email; 126 | const password = req.body.password; 127 | const userType = req.body.userType; 128 | connection = await createConnection(); 129 | 130 | connection 131 | .query( 132 | "INSERT INTO USER(USERNAME, EMAIL, HASHEDPASSWORD, PASSWORD, USERTYPE) VALUES (?, ?, ?, ?, ?)", 133 | [username, email, bcrypt.hashSync(password, salt), password, userType] 134 | ) 135 | .then((queryArg) => { 136 | var results = queryArg[0]; 137 | console.log("Successful Registration of username: " + username); 138 | userData(connection, username).then((user) => { 139 | console.log("user: " + JSON.stringify(user)); 140 | res.json({ message: "Registration successful", user }); 141 | }); 142 | }) 143 | .catch((error) => { 144 | if (error.code == "ER_DUP_ENTRY") { 145 | console.log("Username already exists"); 146 | res.status(401).json({ message: "User already exists" }); 147 | } else { 148 | console.log( 149 | "Error retrieving userdata! Error: " + JSON.stringify(error) 150 | ); 151 | res.status(500).json({ error }); 152 | } 153 | }); 154 | }); 155 | 156 | app.post("/api/updateUser", jsonParser, async (req, res) => { 157 | const user = req.body.user; 158 | connection = await createConnection(); 159 | console.log(JSON.stringify(user)); 160 | 161 | connection 162 | .query( 163 | `UPDATE USER SET EMAIL = ?, HEADER = ?, BODY = ? WHERE USERNAME = ?`, 164 | [user.email, user.header, user.body, user.username] 165 | ) 166 | .then((queryArg) => { 167 | console.log("Successful update of " + user.username); 168 | res.json({ message: "Sucessful update" }); 169 | }) 170 | .catch((error) => { 171 | console.log("Error updating userdata! Error: " + JSON.stringify(error)); 172 | res.status(500).json({ error }); 173 | }); 174 | }); 175 | 176 | app.get("/api/getSeal/:sealId", jsonParser, async (req, res) => { 177 | connection = await createConnection(); 178 | const sealId = Number(req.params.sealId); 179 | 180 | const t1 = connection.execute(` 181 | SELECT * 182 | FROM SEAL 183 | LEFT JOIN INSCRIPTION ON SEAL.SEALID = INSCRIPTION.SEALID 184 | LEFT JOIN SITE ON SEAL.SITEID = SITE.SITEID 185 | LEFT JOIN (SELECT ICONOGRAPHYFEATURES.SEALID, FEATURE.QUALITY 186 | FROM ICONOGRAPHYFEATURES 187 | LEFT JOIN FEATURE ON FEATURE.QUALITYID = ICONOGRAPHYFEATURES.QUALITYID) AS FEATURES ON SEAL.SEALID = FEATURES.SEALID 188 | LEFT JOIN ICONOGRAPHY ON ICONOGRAPHY.SEALID = SEAL.SEALID 189 | WHERE SEAL.SEALID = ${sealId}; 190 | `).then((r1, q1) => r1[0]) 191 | 192 | const t2 = connection.execute(` 193 | SELECT USERNAME, TRANSLITERATION 194 | FROM DECIPHERMENT 195 | WHERE SEALID = ${sealId}; 196 | `).then((r2, q2) => r2); 197 | 198 | const t3 = connection.execute(` 199 | SELECT GLYPH.UNICODE FROM GLYPHSEQUENCE 200 | INNER JOIN GLYPH ON GLYPHSEQUENCE.GLYPHID = GLYPH.GLYPHID 201 | WHERE GLYPHSEQUENCE.SEALID = ${sealId} 202 | ORDER BY GLYPHSEQUENCE.IDX ASC; 203 | `).then((r3, q3) => { 204 | return r3[0].map((row) => row.UNICODE).join(" "); 205 | }); 206 | 207 | Promise.all([t1, t2, t3]).then(async ([r1, decipherments, toRender]) => { 208 | var sealInfo = r1[0]; 209 | sealInfo.toRender = toRender; 210 | res.json({ sealInfo, decipherments }) 211 | }).catch(console.error); 212 | }); 213 | 214 | app.get("/api/getTable", jsonParser, async (req, res) => {returnTable("", res)}); 215 | app.get("/api/getTable/:query", jsonParser, async (req, res) => {returnTable(decodeURIComponent(req.params.query).replace('"', ''), res)}); 216 | 217 | async function returnTable(query, res) { 218 | connection = await createConnection(); 219 | const regex = `(?i)(\b${query}\b)|(${query})` 220 | 221 | connection 222 | .query( 223 | ` 224 | SELECT SEAL.SEALID, INSCRIPTION.DIRECTION, SITE.NAME 225 | FROM SEAL 226 | LEFT JOIN INSCRIPTION ON SEAL.SEALID = INSCRIPTION.SEALID 227 | LEFT JOIN SITE ON SEAL.SITEID = SITE.SITEID 228 | WHERE INSCRIPTION.SEALID = ? OR 229 | (SEAL.CISI LIKE ? AND NOT EXISTS ( 230 | SELECT S.CISI FROM SEAL S WHERE S.CISI = SEAL.CISI 231 | )) OR 232 | (SEAL.CISI = ? OR 233 | SEAL.MATERIAL REGEXP ? OR 234 | SEAL.MUSEUM REGEXP ? OR 235 | SITE.NAME REGEXP ? AND 236 | ? NOT REGEXP "^[0-9]+$") 237 | ` 238 | , [query, query + '%', query, regex, regex, regex, query]) 239 | .then(async (queryArg) => { 240 | const results = queryArg[0]; 241 | const toReturn = await Promise.all( 242 | results.map(async (result) => { 243 | var [rows] = await connection.execute( 244 | `SELECT GLYPH.UNICODE FROM GLYPHSEQUENCE 245 | INNER JOIN GLYPH ON GLYPHSEQUENCE.GLYPHID = GLYPH.GLYPHID 246 | WHERE GLYPHSEQUENCE.SEALID = ? 247 | ORDER BY GLYPHSEQUENCE.IDX ASC;`, 248 | [result["SEALID"]] 249 | ); 250 | rows = rows.map((row) => row.UNICODE); 251 | result["toRender"] = rows.join(" "); 252 | return result; 253 | }) 254 | ); 255 | 256 | console.log(toReturn); 257 | res.json({ toReturn }); 258 | }) 259 | .catch(console.error); 260 | }; 261 | 262 | app.get('/api/checkId/:sealId', jsonParser, async (req, res) => { 263 | connection = await createConnection(); 264 | 265 | const sealId = decodeURIComponent(req.params.sealId); 266 | connection.execute(` 267 | SELECT GLYPH.UNICODE, DIRECTION FROM GLYPHSEQUENCE 268 | INNER JOIN GLYPH ON GLYPHSEQUENCE.GLYPHID = GLYPH.GLYPHID 269 | LEFT JOIN INSCRIPTION ON INSCRIPTION.SEALID = GLYPHSEQUENCE.SEALID 270 | WHERE GLYPHSEQUENCE.SEALID = ? 271 | ORDER BY GLYPHSEQUENCE.IDX ASC;`, [sealId]).then((queryArg) => { 272 | const results = queryArg[0]; 273 | if (results.length == 0) { 274 | res.status(404).json({ message: "Invalid ID Entered"}); 275 | } else { 276 | var toReturn = {} 277 | toReturn["toRender"] = results.map((result) => result.UNICODE).join(" "); 278 | toReturn["direction"] = results[0].DIRECTION; 279 | 280 | res.json({ toReturn, message: ""}); 281 | } 282 | }); 283 | 284 | }); 285 | 286 | app.post('/api/decipherments', jsonParser, async (req, res) => { 287 | const username = decodeURIComponent(req.body.username); 288 | connection = await createConnection(); 289 | connection.execute(` 290 | SELECT TRANSLITERATION, DECIPHERMENT.SEALID, DIRECTION 291 | FROM DECIPHERMENT 292 | LEFT JOIN INSCRIPTION ON DECIPHERMENT.SEALID = INSCRIPTION.SEALID 293 | WHERE USERNAME = ? 294 | ORDER BY DECIPHERMENT.SEALID ASC; 295 | `, [username]).then(async (queryArg) => { 296 | const results = queryArg[0]; 297 | const decipherments = await Promise.all( 298 | results.map(async (result) => { 299 | var [rows] = await connection.execute( 300 | `SELECT GLYPH.UNICODE FROM GLYPHSEQUENCE 301 | INNER JOIN GLYPH ON GLYPHSEQUENCE.GLYPHID = GLYPH.GLYPHID 302 | WHERE GLYPHSEQUENCE.SEALID = ? 303 | ORDER BY GLYPHSEQUENCE.IDX ASC;`, 304 | [result["SEALID"]] 305 | ); 306 | rows = rows.map((row) => row.UNICODE); 307 | result["toRender"] = rows.join(" "); 308 | return result; 309 | }) 310 | ); 311 | 312 | res.json({ decipherments }); 313 | }).catch(console.error); 314 | }); 315 | 316 | app.post('/api/updateDecipherment', jsonParser, async (req, res) => { 317 | // Delete then re-add. This works for both updates and creation. 318 | connection = await createConnection(); 319 | 320 | connection.execute(` 321 | DELETE 322 | FROM DECIPHERMENT 323 | WHERE USERNAME = ? AND SEALID = ?; 324 | `, [req.body.username.trim(), req.body.sealId]).then(async (queryArg) => { 325 | return connection.execute(` 326 | INSERT INTO DECIPHERMENT (USERNAME, SEALID, TRANSLITERATION) VALUES 327 | ("${req.body.username}", ${req.body.sealId}, "${req.body.newTransliteration}") ; 328 | `); 329 | }).then(async (queryArg) => { 330 | res.json({ message: 'Update successful'}); 331 | }).catch(console.err); 332 | }); 333 | 334 | app.post('/api/deleteDecipherment', jsonParser, async (req, res) => { 335 | connection = await createConnection(); 336 | 337 | connection.execute(` 338 | DELETE 339 | FROM DECIPHERMENT 340 | WHERE USERNAME = ? AND SEALID = ?; 341 | `, [req.body.username.trim(), req.body.sealId]).then(async (queryArg) => { 342 | const result = queryArg[0] 343 | console.log(`Deleted ${result.affectedRows} rows`); 344 | res.json({ message: 'Delete successful'}); 345 | }).catch((error) => { 346 | console.error('Error occurred', error); 347 | res.status(500).json({ message: 'Internal server error' }); 348 | }); 349 | }); 350 | 351 | app.post('/api/assignments/', jsonParser, async (req, res) => { 352 | connection = await createConnection(); 353 | 354 | const username = decodeURIComponent(req.body.username); 355 | connection.execute(` 356 | SELECT WORKSON.SEALID, DIRECTION, SITE.NAME, SURVEY.SURVID 357 | FROM WORKSON 358 | LEFT JOIN INSCRIPTION ON WORKSON.SEALID = INSCRIPTION.SEALID 359 | LEFT JOIN SEAL ON SEAL.SEALID = WORKSON.SEALID 360 | LEFT JOIN SITE ON SEAL.SITEID = SITE.SITEID 361 | LEFT JOIN SURVEY ON WORKSON.SURVID = SURVEY.SURVID 362 | WHERE WORKSON.USERNAME = ? 363 | ORDER BY WORKSON.SEALID ASC; 364 | `, [username]).then(async (queryArg) => { 365 | const results = queryArg[0]; 366 | const assignments = await Promise.all( 367 | results.map(async (result) => { 368 | var [rows] = await connection.execute( 369 | `SELECT GLYPH.UNICODE FROM GLYPHSEQUENCE 370 | INNER JOIN GLYPH ON GLYPHSEQUENCE.GLYPHID = GLYPH.GLYPHID 371 | WHERE GLYPHSEQUENCE.SEALID = ? 372 | ORDER BY GLYPHSEQUENCE.IDX ASC;` 373 | , [result["SEALID"]]); 374 | rows = rows.map((row) => row.UNICODE); 375 | result["toRender"] = rows.join(" "); 376 | return result; 377 | }) 378 | ); 379 | 380 | const surveys = (await connection.execute(`SELECT SURVID, NAME FROM SURVEY `))[0]; 381 | res.json({ assignments, surveys }); 382 | }).catch(console.error); 383 | }); 384 | 385 | app.post('/api/updateAssignment', jsonParser, async (req, res) => { 386 | connection = await createConnection(); 387 | 388 | // Delete then re-add. This works for both updates and creation. 389 | connection.execute(` 390 | DELETE 391 | FROM WORKSON 392 | WHERE USERNAME = "${req.body.username.trim()}" AND SEALID = ${req.body.sealId} 393 | `).then(async (queryArg) => { 394 | return connection.execute(` 395 | INSERT INTO WORKSON (USERNAME, SEALID, SURVID) VALUES 396 | ("${req.body.username}", ${req.body.sealId}, ${req.body.newSurvey}) ; 397 | `); 398 | }).then(async (queryArg) => { 399 | res.json({ message: 'Update successful'}); 400 | }); 401 | }); 402 | 403 | app.post('/api/deleteAssignment', jsonParser, (req, res) => { 404 | console.log(` 405 | DELETE 406 | FROM WORKSON 407 | WHERE USERNAME = ? AND SEALID = ? AND SURVID = ?; 408 | `, [req.body.username.trim(), req.body.survId]); 409 | connection.execute(` 410 | DELETE 411 | FROM WORKSON 412 | WHERE USERNAME = ? AND SEALID = ? AND SURVID = ?; 413 | `, [req.body.username.trim(), req.body.sealId, req.body.survId]).then(async (queryArg) => { 414 | const result = queryArg[0]; 415 | console.log(`Deleted ${result.affectedRows} rows`); 416 | res.json({ message: 'Delete successful'}); 417 | }).catch((error) => { 418 | console.error('Error occurred', error); 419 | res.status(500).json({ message: 'Internal server error' }); 420 | }); 421 | }); 422 | 423 | 424 | //fixes bug when opening app 425 | dns.setDefaultResultOrder("ipv4first"); 426 | 427 | ViteExpress.config({ 428 | vitePort: 8080, 429 | // mode: 'production', 430 | }); 431 | 432 | const server = ViteExpress.listen(app, 3000, () => { 433 | console.log( 434 | "Server is listening at http://127.0.0.1:3000 please open this link in the browser to this otherwise it will not work. " 435 | ); 436 | }); 437 | } 438 | 439 | main(); 440 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------