alamin/websurfx
alamin/websurfx
0
0
Fork 0
mirror of https://github.com/neon-mmd/websurfx.git synced 2024-12-22 20:38:22 -05:00
Code Issues Releases Activity

Merge branch 'rolling' into patch-and-improve-dockerfile

Browse Source
This commit is contained in:
neon_arch 2023-07-10 19:49:29 +03:00 committed by GitHub
commit a0565f1893
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
46 changed files with 442 additions and 265 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
.cspell.json Normal file
View File

@ -0,0 +1,16 @@
{
"ignorePaths": [
"**/node_modules/**",
"**/vscode-extension/**",
"**/.git/**",
"**/.pnpm-lock.json",
".vscode",
"megalinter",
"package-lock.json",
"report"
],
"language": "en",
"noConfigSearch": true,
"words": ["megalinter", "oxsecurity"],
"version": "0.2"
}

3
.github/workflows/contributors.yml vendored
View File

@ -1,3 +1,4 @@
---
name: Contributors List
on:
@ -44,4 +45,4 @@ jobs:
delete-branch: true
title: 'chore: update contributors-list'
body: |
Automated update to `images/contributors_list.svg`
Automated update to `images/contributors_list.svg`

1
.github/workflows/hello.yml vendored
View File

@ -1,3 +1,4 @@
---
name: Welcome first time contributors
on:

1
.github/workflows/labels.yml vendored
View File

@ -1,3 +1,4 @@
---
name: Import open source standard labels
on:

89
.github/workflows/mega-linter.yml vendored Normal file
View File

@ -0,0 +1,89 @@
---
# MegaLinter GitHub Action configuration file
# More info at https://megalinter.io
name: MegaLinter
on:
# Trigger mega-linter at every push. Action will also be visible from Pull Requests to rolling
push: # Comment this line to trigger action only on pull-requests (not recommended if you don't pay for GH Actions)
pull_request:
branches: [rolling]
env: # Comment env block if you do not want to apply fixes
# Apply linter fixes configuration
APPLY_FIXES: all # When active, APPLY_FIXES must also be defined as environment variable (in github/workflows/mega-linter.yml or other CI tool)
APPLY_FIXES_EVENT: pull_request # Decide which event triggers application of fixes in a commit or a PR (pull_request, push, all)
APPLY_FIXES_MODE: commit # If APPLY_FIXES is used, defines if the fixes are directly committed (commit) or posted in a PR (pull_request)
concurrency:
group: ${{ github.ref }}-${{ github.workflow }}
cancel-in-progress: true
jobs:
build:
name: MegaLinter
runs-on: ubuntu-latest
permissions:
# Give the default GITHUB_TOKEN write permission to commit and push, comment issues & post new PR
# Remove the ones you do not need
contents: write
issues: write
pull-requests: write
steps:
# Git Checkout
- name: Checkout Code
uses: actions/checkout@v3
with:
token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
# MegaLinter
- name: MegaLinter
id: ml
# You can override MegaLinter flavor used to have faster performances
# More info at https://megalinter.io/flavors/
uses: oxsecurity/megalinter/flavors/cupcake@v7.1.0
env:
# All available variables are described in documentation
# https://megalinter.io/configuration/
VALIDATE_ALL_CODEBASE: true # Set ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} to validate only diff with main branch
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# ADD YOUR CUSTOM ENV VARIABLES HERE TO OVERRIDE VALUES OF .mega-linter.yml AT THE ROOT OF YOUR REPOSITORY
# Upload MegaLinter artifacts
- name: Archive production artifacts
if: ${{ success() }} || ${{ failure() }}
uses: actions/upload-artifact@v3
with:
name: MegaLinter reports
path: |
megalinter-reports
mega-linter.log
# Create pull request if applicable (for now works only on PR from same repository, not from forks)
- name: Create Pull Request with applied fixes
id: cpr
if: steps.ml.outputs.has_updated_sources == 1 && (env.APPLY_FIXES_EVENT == 'all' || env.APPLY_FIXES_EVENT == github.event_name) && env.APPLY_FIXES_MODE == 'pull_request' && (github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository) && !contains(github.event.head_commit.message, 'skip fix')
uses: peter-evans/create-pull-request@v5
with:
token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
commit-message: "[MegaLinter] Apply linters automatic fixes"
title: "[MegaLinter] Apply linters automatic fixes"
labels: bot
- name: Create PR output
if: steps.ml.outputs.has_updated_sources == 1 && (env.APPLY_FIXES_EVENT == 'all' || env.APPLY_FIXES_EVENT == github.event_name) && env.APPLY_FIXES_MODE == 'pull_request' && (github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository) && !contains(github.event.head_commit.message, 'skip fix')
run: |
echo "Pull Request Number - ${{ steps.cpr.outputs.pull-request-number }}"
echo "Pull Request URL - ${{ steps.cpr.outputs.pull-request-url }}"
# Push new commit if applicable (for now works only on PR from same repository, not from forks)
- name: Prepare commit
if: steps.ml.outputs.has_updated_sources == 1 && (env.APPLY_FIXES_EVENT == 'all' || env.APPLY_FIXES_EVENT == github.event_name) && env.APPLY_FIXES_MODE == 'commit' && github.ref != 'refs/heads/main' && (github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository) && !contains(github.event.head_commit.message, 'skip fix')
run: sudo chown -Rc $UID .git/
- name: Commit and push applied linter fixes
if: steps.ml.outputs.has_updated_sources == 1 && (env.APPLY_FIXES_EVENT == 'all' || env.APPLY_FIXES_EVENT == github.event_name) && env.APPLY_FIXES_MODE == 'commit' && github.ref != 'refs/heads/main' && (github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository) && !contains(github.event.head_commit.message, 'skip fix')
uses: stefanzweifel/git-auto-commit-action@v4
with:
branch: ${{ github.event.pull_request.head.ref || github.head_ref || github.ref }}
commit_message: "[MegaLinter] Apply linters fixes"
commit_user_name: megalinter-bot
commit_user_email: nicolas.vuillamy@ox.security

1
.github/workflows/rust.yml vendored
View File

@ -1,3 +1,4 @@
---
name: Rust
on:

1
.github/workflows/rust_format.yml vendored
View File

@ -1,3 +1,4 @@
---
name: Rust format and clippy checks
on:
push:

1
.github/workflows/stale.yml vendored
View File

@ -1,3 +1,4 @@
---
# This workflow warns and then closes issues and PRs that have had no activity for a specified amount of time.
#
# You can adjust the behavior by modifying this file.

1
.gitignore vendored
View File

@ -3,3 +3,4 @@ package.json
package-lock.json
dump.rdb
.vscode
megalinter-reports/

33
.gitpod.yml
View File

@ -1,22 +1,23 @@
---
image: ubuntu:latest
image: gitpod/workspace-base
# Commands that will run on workspace start
tasks:
- name: Setup, Install & Build
- before: apt install cargo redis-server nodejs npm && cargo test
- init: cargo install cargo-watch
- command: redis-server --port 8080 & cargo watch -q -w "." -x "run"
before: apt install cargo redis-server nodejs npm -y && cargo test
init: cargo install cargo-watch
command: redis-server --port 8080 & cargo watch -q -w "." -x "run"
# Ports to expose on workspace startup
ports:
- port: 8080
- onOpen: open-preview
- name: Website
- description: Website Preview
description: Website Preview
port: 8080
onOpen: open-preview
# vscode IDE setup
vscode:
extensions:
- vadimcn.vscode-lldb
- rust-lang.rust-analyzer
- cschleiden.vscode-github-actions
- rust-lang.rust
- bungcip.better-toml
- serayuzgur.crates
- usernamehw.errorlens
@ -27,19 +28,17 @@ vscode:
- evgeniypeshkov.syntax-highlighter
- redhat.vscode-yaml
- ms-azuretools.vscode-docker
- GitHub.vscode-github-actions
- Catppuccin.catppuccin-vsc
- PKief.material-icon-theme
- tal7aouy.rainbow-bracket
- oderwat.indent-rainbow
- formulahendry.auto-rename-tag
- eamodio.gitlens
github:
prebuilds:
- master: true
- branches: true
- pullRequests: true
- pullRequestsFromForks: true
- addCheck: true
- addComment: false
- addBadge: true
master: true
branches: true
pullRequests: true
pullRequestsFromForks: true
addCheck: true
addComment: false
addBadge: true

22
.mega-linter.yml Normal file
View File

@ -0,0 +1,22 @@
---
# Configuration file for MegaLinter
# See all available variables at https://megalinter.io/configuration/ and in linters documentation
APPLY_FIXES: all # all, none, or list of linter keys
# ENABLE: # If you use ENABLE variable, all other languages/formats/tooling-formats will be disabled by default
ENABLE_LINTERS: # If you use ENABLE_LINTERS variable, all other linters will be disabled by default
- RUST_CLIPPY
- JAVASCRIPT_ES
- CSS_STYLELINT
- MARKDOWN_MARKDOWNLINT
- YAML_YAMLLINT
- HTML_DJLINT
- ACTION_ACTIONLINT
- DOCKERFILE_HADOLINT
- SPELL_CSPELL
# DISABLE:
# - COPYPASTE # Uncomment to disable checks of excessive copy-pastes
# - SPELL # Uncomment to disable checks of spelling mistakes
SHOW_ELAPSED_TIME: true
FILEIO_REPORTER: false
# DISABLE_ERRORS: true # Uncomment if you want MegaLinter to detect errors but not block CI to pass

1
docker-compose.yml
View File

@ -1,3 +1,4 @@
---
version: "3.9"
services:
app:

18
public/static/colorschemes/catppuccin-mocha.css
View File

@ -1,11 +1,11 @@
:root {
--bg: #1e1e2e;
--fg: #cdd6f4;
--1: #45475a;
--2: #f38ba8;
--3: #a6e3a1;
--4: #f9e2af;
--5: #89b4fa;
--6: #f5c2e7;
--7: #ffffff;
--background-color: #1e1e2e;
--foreground-color: #cdd6f4;
--color-one: #45475a;
--color-two: #f38ba8;
--color-three: #a6e3a1;
--color-four: #f9e2af;
--color-five: #89b4fa;
--color-six: #f5c2e7;
--color-seven: #ffffff;
}

20
public/static/colorschemes/dark-chocolate.css
View File

@ -1,11 +1,11 @@
:root {
--bg: #000000;
--fg: #ffffff;
--1: #121212;
--2: #808080;
--3: #999999;
--4: #666666;
--5: #bfbfbf;
--6: #e0e0e0;
--7: #555555;
}
--background-color: #000000;
--foreground-color: #ffffff;
--color-one: #121212;
--color-two: #808080;
--color-three: #999999;
--color-four: #666666;
--color-five: #bfbfbf;
--color-six: #e0e0e0;
--color-seven: #555555;
}

18
public/static/colorschemes/dracula.css
View File

@ -1,11 +1,11 @@
:root {
--bg: #44475a;
--fg: #8be9fd;
--1: #ff5555;
--2: #50fa7b;
--3: #ffb86c;
--4: #bd93f9;
--5: #ff79c6;
--6: #94a3a5;
--7: #ffffff;
--background-color: #44475a;
--foreground-color: #8be9fd;
--color-one: #ff5555;
--color-two: #50fa7b;
--color-three: #ffb86c;
--color-four: #bd93f9;
--color-five: #ff79c6;
--color-six: #94a3a5;
--color-seven: #ffffff;
}

18
public/static/colorschemes/gruvbox-dark.css
View File

@ -1,11 +1,11 @@
:root {
--bg: #282828;
--fg: #ebdbb2;
--1: #cc241d;
--2: #98971a;
--3: #d79921;
--4: #458588;
--5: #b16286;
--6: #689d6a;
--7: #ffffff;
--background-color: #1d2021;
--foreground-color: #ebdbb2;
--color-one: #282828;
--color-two: #98971a;
--color-three: #d79921;
--color-four: #458588;
--color-five: #b16286;
--color-six: #689d6a;
--color-seven: #ffffff;
}

18
public/static/colorschemes/monokai.css
View File

@ -1,11 +1,11 @@
:root {
--bg: #403e41;
--fg: #fcfcfa;
--1: #ff6188;
--2: #a9dc76;
--3: #ffd866;
--4: #fc9867;
--5: #ab9df2;
--6: #78dce8;
--7: #ffffff;
--background-color: #49483Eff;
--foreground-color: #FFB269;
--color-one: #272822ff;
--color-two: #61AFEF;
--color-three: #ffd866;
--color-four: #fc9867;
--color-five: #ab9df2;
--color-six: #78dce8;
--color-seven: #ffffff;
}

18
public/static/colorschemes/nord.css
View File

@ -1,11 +1,11 @@
:root {
--bg: #2e3440;
--fg: #d8dee9;
--1: #3b4252;
--2: #bf616a;
--3: #a3be8c;
--4: #ebcb8b;
--5: #81a1c1;
--6: #b48ead;
--7: #ffffff;
--background-color: #122736ff;
--foreground-color: #a2e2a9;
--color-one: #121B2Cff;
--color-two: #f08282;
--color-three: #ABC5AAff;
--color-four: #e6d2d2;
--color-five: #81a1c1;
--color-six: #e2ecd6;
--color-seven: #fff;
}

18
public/static/colorschemes/oceanic-next.css
View File

@ -1,11 +1,11 @@
:root {
--bg: #1b2b34;
--fg: #d8dee9;
--1: #343d46;
--2: #ec5f67;
--3: #99c794;
--4: #fac863;
--5: #6699cc;
--6: #c594c5;
--7: #ffffff;
--background-color: #1b2b34;
--foreground-color: #d8dee9;
--color-one: #343d46;
--color-two: #5FB3B3ff;
--color-three: #69Cf;
--color-four: #99c794;
--color-five: #69c;
--color-six: #c594c5;
--color-seven: #D8DEE9ff;
}

18
public/static/colorschemes/one-dark.css
View File

@ -1,11 +1,11 @@
:root {
--bg: #282c34;
--fg: #abb2bf;
--1: #3b4048;
--2: #a3be8c;
--3: #b48ead;
--4: #c8ccd4;
--5: #e06c75;
--6: #61afef;
--7: #be5046;
--background-color: #282c34;
--foreground-color: #abb2bf;
--color-one: #3b4048;
--color-two: #a3be8c;
--color-three: #b48ead;
--color-four: #c8ccd4;
--color-five: #e06c75;
--color-six: #61afef;
--color-seven: #be5046;
}

18
public/static/colorschemes/solarized-dark.css
View File

@ -1,11 +1,11 @@
:root {
--bg: #002b36;
--fg: #839496;
--1: #073642;
--2: #dc322f;
--3: #859900;
--4: #b58900;
--5: #268bd2;
--6: #d33682;
--7: #ffffff;
--background-color: #002b36;
--foreground-color: #c9e0e6;
--color-one: #073642;
--color-two: #2AA198ff;
--color-three: #2AA198ff;
--color-four: #EEE8D5ff;
--color-five: #268bd2;
--color-six: #d33682;
--color-seven: #fff;
}

18
public/static/colorschemes/solarized-light.css
View File

@ -1,11 +1,11 @@
:root {
--bg: #fdf6e3;
--fg: #657b83;
--1: #073642;
--2: #dc322f;
--3: #859900;
--4: #b58900;
--5: #268bd2;
--6: #d33682;
--7: #ffffff;
--background-color: #EEE8D5ff;
--foreground-color: #b1ab97;
--color-one: #fdf6e3;
--color-two: #DC322Fff;
--color-three: #586E75ff;
--color-four: #b58900;
--color-five: #268bd2;
--color-six: #d33682;
--color-seven: #fff;
}

18
public/static/colorschemes/tokyo-night.css
View File

@ -1,11 +1,11 @@
:root {
--bg: #1a1b26;
--fg: #c0caf5;
--1: #32364a;
--2: #a9b1d6;
--3: #5a5bb8;
--4: #6b7089;
--5: #e2afff;
--6: #a9a1e1;
--7: #988bc7;
--background-color: #1a1b26;
--foreground-color: #c0caf5;
--color-one: #32364a;
--color-two: #a9b1d6;
--color-three: #5a5bb8;
--color-four: #6b7089;
--color-five: #e2afff;
--color-six: #a9a1e1;
--color-seven: #988bc7;
}

18
public/static/colorschemes/tomorrow-night.css
View File

@ -1,11 +1,11 @@
:root {
--bg: #1d1f21;
--fg: #c5c8c6;
--1: #cc6666;
--2: #b5bd68;
--3: #f0c674;
--4: #81a2be;
--5: #b294bb;
--6: #8abeb7;
--7: #ffffff;
--background-color: #35383Cff;
--foreground-color: #D7DAD8ff;
--color-one: #1d1f21;
--color-two: #D77C79ff;
--color-three: #f0c674;
--color-four: #92B2CAff;
--color-five: #C0A7C7ff;
--color-six: #9AC9C4ff;
--color-seven: #fff;
}

19
public/static/cookies.js
View File

@ -1,15 +1,26 @@
// This function is executed when any page on the website finishes loading and
// this function retrieves the cookies if it is present on the user's machine.
// If it is available then the saved cookies is display in the cookies tab
// otherwise an appropriate message is displayed if it is not available.
/**
* This function is executed when any page on the website finishes loading and
* this function retrieves the cookies if it is present on the user's machine.
* If it is available then the saved cookies is display in the cookies tab
* otherwise an appropriate message is displayed if it is not available.
*
* @function
* @listens DOMContentLoaded
* @returns {void}
*/
document.addEventListener(
'DOMContentLoaded',
() => {
try {
// Decode the cookie value
let cookie = decodeURIComponent(document.cookie)
// Set the value of the input field to the decoded cookie value if it is not empty
// Otherwise, display a message indicating that no cookies have been saved on the user's system
document.querySelector('.cookies input').value =
cookie !== '' ? cookie : 'No cookies have been saved on your system'
} catch (error) {
// If there is an error decoding the cookie, log the error to the console
// and display an error message in the input field
console.error('Error decoding cookie:', error)
document.querySelector('.cookies input').value = 'Error decoding cookie'
}

4
public/static/pagination.js
View File

@ -1,5 +1,5 @@
/**
* Navigates to the next page by incrementing the current page number in the URL query parameters.
* Navigates to the next page by incrementing the current page number in the URL query string.
* @returns {void}
*/
function navigate_forward() {
@ -19,7 +19,7 @@ function navigate_forward() {
}
/**
* Navigates to the previous page by decrementing the current page number in the URL query parameters.
* Navigates to the previous page by decrementing the current page number in the URL query string.
* @returns {void}
*/
function navigate_backward() {

46
public/static/settings.js
View File

@ -1,5 +1,7 @@
// This function handles the toggling of selections of all upstream search engines
// options in the settings page under the tab engines.
/**
* This function handles the toggling of selections of all upstream search engines
* options in the settings page under the tab engines.
*/
function toggleAllSelection() {
document
.querySelectorAll('.engine')
@ -10,25 +12,36 @@ function toggleAllSelection() {
)
}
// This function adds the functionality to sidebar buttons to only show settings
// related to that tab.
/**
* This function adds the functionality to sidebar buttons to only show settings
* related to that tab.
* @param {HTMLElement} current_tab - The current tab that was clicked.
*/
function setActiveTab(current_tab) {
// Remove the active class from all tabs and buttons
document
.querySelectorAll('.tab')
.forEach((tab) => tab.classList.remove('active'))
document
.querySelectorAll('.btn')
.forEach((tab) => tab.classList.remove('active'))
// Add the active class to the current tab and its corresponding settings
current_tab.classList.add('active')
document
.querySelector(`.${current_tab.innerText.toLowerCase().replace(' ', '_')}`)
.classList.add('active')
}
// This function adds the functionality to save all the user selected preferences
// to be saved in a cookie on the users machine.
/**
* This function adds the functionality to save all the user selected preferences
* to be saved in a cookie on the users machine.
*/
function setClientSettings() {
// Create an object to store the user's preferences
let cookie_dictionary = new Object()
// Loop through all select tags and add their values to the cookie dictionary
document.querySelectorAll('select').forEach((select_tag) => {
if (select_tag.name === 'themes') {
cookie_dictionary['theme'] = select_tag.value
@ -36,6 +49,8 @@ function setClientSettings() {
cookie_dictionary['colorscheme'] = select_tag.value
}
})
// Loop through all engine checkboxes and add their values to the cookie dictionary
let engines = []
document.querySelectorAll('.engine').forEach((engine_checkbox) => {
if (engine_checkbox.checked === true) {
@ -43,33 +58,44 @@ function setClientSettings() {
}
})
cookie_dictionary['engines'] = engines
// Set the expiration date for the cookie to 1 year from the current date
let expiration_date = new Date()
expiration_date.setFullYear(expiration_date.getFullYear() + 1)
// Save the cookie to the user's machine
document.cookie = `appCookie=${JSON.stringify(
cookie_dictionary
)}; expires=${expiration_date.toUTCString()}`
// Display a success message to the user
document.querySelector('.message').innerText =
'✅ The settings have been saved sucessfully!!'
// Clear the success message after 10 seconds
setTimeout(() => {
document.querySelector('.message').innerText = ''
}, 10000)
}
// This functions gets the saved cookies if it is present on the user's machine If it
// is available then it is parsed and converted to an object which is then used to
// retrieve the preferences that the user had selected previously and is then loaded in the
// website otherwise the function does nothing and the default server side settings are loaded.
/**
* This functions gets the saved cookies if it is present on the user's machine If it
* is available then it is parsed and converted to an object which is then used to
* retrieve the preferences that the user had selected previously and is then loaded in the
* website otherwise the function does nothing and the default server side settings are loaded.
*/
function getClientSettings() {
// Get the appCookie from the user's machine
let cookie = decodeURIComponent(document.cookie)
// If the cookie is not empty, parse it and use it to set the user's preferences
if (cookie !== '') {
let cookie_value = decodeURIComponent(document.cookie)
.split(';')
.map((item) => item.split('='))
.reduce((acc, [_, v]) => (acc = JSON.parse(v)) && acc, {})
// Loop through all link tags and update their href values to match the user's preferences
let links = Array.from(document.querySelectorAll('link')).forEach(
(item) => {
if (item.href.includes('static/themes')) {

84
public/static/themes/simple.css
View File

@ -16,7 +16,7 @@ body {
justify-content: space-between;
align-items: center;
height: 100vh;
background: var(--1);
background: var(--color-one);
}
/* styles for the index page */
@ -46,7 +46,7 @@ body {
outline: none;
border: none;
box-shadow: rgba(0, 0, 0, 1);
background: var(--fg);
background: var(--foreground-color);
}
.search_bar button {
@ -59,8 +59,8 @@ body {
outline: none;
border: none;
gap: 0;
background: var(--bg);
color: var(--3);
background: var(--background-color);
color: var(--color-three);
font-weight: 600;
letter-spacing: 0.1rem;
}
@ -73,7 +73,7 @@ body {
/* styles for the footer and header */
header {
background: var(--bg);
background: var(--background-color);
width: 100%;
display: flex;
justify-content: right;
@ -96,7 +96,7 @@ footer ul li a,
header ul li a:visited,
footer ul li a:visited {
text-decoration: none;
color: var(--2);
color: var(--color-two);
text-transform: capitalize;
letter-spacing: 0.1rem;
}
@ -107,12 +107,12 @@ header ul li a {
header ul li a:hover,
footer ul li a:hover {
color: var(--5);
color: var(--color-five);
}
footer div span {
font-size: 1.5rem;
color: var(--4);
color: var(--color-four);
}
footer div {
@ -121,7 +121,7 @@ footer div {
}
footer {
background: var(--bg);
background: var(--background-color);
width: 100%;
padding: 1rem;
display: flex;
@ -158,28 +158,28 @@ footer {
.results_aggregated .result h1 a {
font-size: 1.5rem;
color: var(--2);
color: var(--color-two);
text-decoration: none;
letter-spacing: 0.1rem;
}
.results_aggregated .result h1 a:hover {
color: var(--5);
color: var(--color-five);
}
.results_aggregated .result h1 a:visited {
color: var(--bg);
color: var(--background-color);
}
.results_aggregated .result small {
color: var(--3);
color: var(--color-three);
font-size: 1.1rem;
word-wrap: break-word;
line-break: anywhere;
}
.results_aggregated .result p {
color: var(--fg);
color: var(--foreground-color);
font-size: 1.2rem;
margin-top: 0.3rem;
word-wrap: break-word;
@ -190,7 +190,7 @@ footer {
text-align: right;
font-size: 1.2rem;
padding: 1rem;
color: var(--5);
color: var(--color-five);
}
/* Styles for the 404 page */
@ -233,12 +233,12 @@ footer {
.error_content p a,
.error_content p a:visited {
color: var(--2);
color: var(--color-two);
text-decoration: none;
}
.error_content p a:hover {
color: var(--5);
color: var(--color-five);
}
.page_navigation {
@ -249,8 +249,8 @@ footer {
}
.page_navigation button {
background: var(--bg);
color: var(--fg);
background: var(--background-color);
color: var(--foreground-color);
padding: 1rem;
border-radius: 0.5rem;
outline: none;
@ -265,12 +265,12 @@ footer {
.about-container article {
font-size: 1.5rem;
color: var(--fg);
color: var(--foreground-color);
padding-bottom: 10px;
}
.about-container article h1 {
color: var(--2);
color: var(--color-two);
font-size: 2.8rem;
}
@ -279,17 +279,17 @@ footer {
}
.about-container a {
color: var(--3);
color: var(--color-three);
}
.about-container article h2 {
color: var(--3);
color: var(--color-three);
font-size: 1.8rem;
padding-bottom: 10px;
}
.about-container p {
color: var(--fg);
color: var(--foreground-color);
font-size: 1.6rem;
padding-bottom: 10px;
}
@ -310,12 +310,12 @@ footer {
}
.settings h1 {
color: var(--2);
color: var(--color-two);
font-size: 2.5rem;
}
.settings hr {
border-color: var(--3);
border-color: var(--color-three);
margin: 0.3rem 0 1rem 0;
}
@ -331,7 +331,7 @@ footer {
border-radius: 5px;
font-weight: bold;
margin-bottom: 0.5rem;
color: var(--fg);
color: var(--foreground-color);
text-transform: capitalize;
gap: 1.5rem;
}
@ -342,12 +342,12 @@ footer {
}
.settings_container .sidebar .btn.active {
background-color: var(--2);
background-color: var(--color-two);
}
.settings_container .main_container {
width: 70%;
border-left: 1.5px solid var(--3);
border-left: 1.5px solid var(--color-three);
padding-left: 3rem;
}
@ -365,8 +365,8 @@ footer {
margin-top: 1rem;
padding: 1rem 2rem;
font-size: 1.5rem;
background: var(--3);
color: var(--bg);
background: var(--color-three);
color: var(--background-color);
border-radius: 0.5rem;
border: 2px solid transparent;
font-weight: bold;
@ -383,13 +383,13 @@ footer {
.settings_container .main_container .message {
font-size: 1.5rem;
color: var(--fg);
color: var(--foreground-color);
}
.settings_container .tab h3 {
font-size: 2rem;
font-weight: bold;
color: var(--4);
color: var(--color-four);
margin-top: 1.5rem;
text-transform: capitalize;
}
@ -397,14 +397,14 @@ footer {
.settings_container .tab .description {
font-size: 1.5rem;
margin-bottom: 0.5rem;
color: var(--fg);
color: var(--foreground-color);
}
.settings_container .user_interface select {
margin: 0.7rem 0;
width: 20rem;
background-color: var(--bg);
color: var(--fg);
background-color: var(--background-color);
color: var(--foreground-color);
padding: 1rem 2rem;
border-radius: 0.5rem;
outline: none;
@ -413,7 +413,7 @@ footer {
}
.settings_container .user_interface option:hover {
background-color: var(--1);
background-color: var(--color-one);
}
.settings_container .engines .engine_selection {
@ -425,7 +425,7 @@ footer {
}
.settings_container .engines .toggle_btn {
color: var(--fg);
color: var(--foreground-color);
font-size: 1.5rem;
display: flex;
gap: 0.5rem;
@ -464,7 +464,7 @@ footer {
left: 0;
right: 0;
bottom: 0;
background-color: var(--bg);
background-color: var(--background-color);
-webkit-transition: 0.4s;
transition: 0.4s;
}
@ -476,17 +476,17 @@ footer {
width: 2.6rem;
left: 0.4rem;
bottom: 0.4rem;
background-color: var(--fg);
background-color: var(--foreground-color);
-webkit-transition: 0.4s;
transition: 0.4s;
}
input:checked + .slider {
background-color: var(--3);
background-color: var(--color-three);
}
input:focus + .slider {
box-shadow: 0 0 1px var(--3);
box-shadow: 0 0 1px var(--color-three);
}
input:checked + .slider:before {

6
public/templates/search.html
View File

@ -4,12 +4,12 @@
<div class="results_aggregated">
{{#each results}}
<div class="result">
<h1><a href="{{this.visitingUrl}}">{{{this.title}}}</a></h1>
<small>{{this.url}}</small>
<h1><a href="/{{{this.visitingUrl}}}">{{{this.title}}}</a></h1>
<small>{{{this.url}}}</small>
<p>{{{this.description}}}</p>
<div class="upstream_engines">
{{#each engine}}
<span>{{this}}</span>
<span>{{{this}}}</span>
{{/each}}
</div>
</div>

4
src/bin/websurfx.rs
View File

@ -5,7 +5,7 @@
use std::net::TcpListener;
use websurfx::{config_parser::parser::Config, run};
use websurfx::{config::parser::Config, run};
/// The function that launches the main server and registers all the routes of the website.
///
@ -26,7 +26,7 @@ async fn main() -> std::io::Result<()> {
log::info!("started server on port {}", config.port);
let listener = TcpListener::bind((config.binding_ip_addr.clone(), config.port))?;
let listener = TcpListener::bind((config.binding_ip.clone(), config.port))?;
run(listener, config)?.await
}

8
src/cache/cacher.rs vendored
View File

@ -32,7 +32,7 @@ impl RedisCache {
/// # Arguments
///
/// * `url` - It takes an url as string.
fn compute_url_hash(url: &str) -> String {
fn hash_url(url: &str) -> String {
format!("{:?}", compute(url))
}
@ -41,8 +41,8 @@ impl RedisCache {
/// # Arguments
///
/// * `url` - It takes an url as a string.
pub fn cached_results_json(&mut self, url: &str) -> Result<String, Box<dyn std::error::Error>> {
let hashed_url_string = Self::compute_url_hash(url);
pub fn cached_json(&mut self, url: &str) -> Result<String, Box<dyn std::error::Error>> {
let hashed_url_string = Self::hash_url(url);
Ok(self.connection.get(hashed_url_string)?)
}
@ -59,7 +59,7 @@ impl RedisCache {
json_results: String,
url: &str,
) -> Result<(), Box<dyn std::error::Error>> {
let hashed_url_string = Self::compute_url_hash(url);
let hashed_url_string = Self::hash_url(url);
// put results_json into cache
self.connection.set(&hashed_url_string, json_results)?;

0
src/config_parser/mod.rs → src/config/mod.rs
View File

16
src/config_parser/parser.rs → src/config/parser.rs
View File

@ -14,16 +14,16 @@ static CONFIG_FILE_NAME: &str = "config.lua";
/// # Fields
//
/// * `port` - It stores the parsed port number option on which the server should launch.
/// * `binding_ip_addr` - It stores the parsed ip address option on which the server should launch
/// * `binding_ip` - It stores the parsed ip address option on which the server should launch
/// * `style` - It stores the theming options for the website.
/// * `redis_connection_url` - It stores the redis connection url address on which the redis
/// * `redis_url` - It stores the redis connection url address on which the redis
/// client should connect.
#[derive(Clone)]
pub struct Config {
pub port: u16,
pub binding_ip_addr: String,
pub binding_ip: String,
pub style: Style,
pub redis_connection_url: String,
pub redis_url: String,
pub aggregator: AggregatorConfig,
pub logging: bool,
pub debug: bool,
@ -50,17 +50,17 @@ impl Config {
let globals = context.globals();
context
.load(&fs::read_to_string(Config::get_config_path()?)?)
.load(&fs::read_to_string(Config::config_path()?)?)
.exec()?;
Ok(Config {
port: globals.get::<_, u16>("port")?,
binding_ip_addr: globals.get::<_, String>("binding_ip_addr")?,
binding_ip: globals.get::<_, String>("binding_ip")?,
style: Style::new(
globals.get::<_, String>("theme")?,
globals.get::<_, String>("colorscheme")?,
),
redis_connection_url: globals.get::<_, String>("redis_connection_url")?,
redis_url: globals.get::<_, String>("redis_url")?,
aggregator: AggregatorConfig {
random_delay: globals.get::<_, bool>("production_use")?,
},
@ -81,7 +81,7 @@ impl Config {
/// one (3).
/// 3. `websurfx/` (under project folder ( or codebase in other words)) if it is not present
/// here then it returns an error as mentioned above.
fn get_config_path() -> Result<String, Box<dyn std::error::Error>> {
fn config_path() -> Result<String, Box<dyn std::error::Error>> {
// check user config
let path = format!(

0
src/config_parser/parser_models.rs → src/config/parser_models.rs
View File

2
src/engines/duckduckgo.rs
View File

@ -7,7 +7,7 @@ use std::{collections::HashMap, time::Duration};
use reqwest::header::{HeaderMap, CONTENT_TYPE, COOKIE, REFERER, USER_AGENT};
use scraper::{Html, Selector};
use crate::search_results_handler::aggregation_models::RawSearchResult;
use crate::results::aggregation_models::RawSearchResult;
use super::engine_models::EngineError;

2
src/engines/searx.rs
View File

@ -6,7 +6,7 @@ use reqwest::header::{HeaderMap, CONTENT_TYPE, COOKIE, REFERER, USER_AGENT};
use scraper::{Html, Selector};
use std::collections::HashMap;
use crate::search_results_handler::aggregation_models::RawSearchResult;
use crate::results::aggregation_models::RawSearchResult;
use super::engine_models::EngineError;
use error_stack::{IntoReport, Report, Result, ResultExt};

2
src/handler/mod.rs
View File

@ -1 +1 @@
pub mod public_path_handler;
pub mod public_paths;

20
src/handler/public_path_handler.rs → src/handler/public_paths.rs
View File

@ -17,15 +17,17 @@ static PUBLIC_DIRECTORY_NAME: &str = "public";
/// 1. `/opt/websurfx` if it not present here then it fallbacks to the next one (2)
/// 2. Under project folder ( or codebase in other words) if it is not present
/// here then it returns an error as mentioned above.
pub fn handle_different_public_path() -> Result<String, Error> {
pub fn public_path() -> Result<String, Error> {
if Path::new(format!("/opt/websurfx/{}/", PUBLIC_DIRECTORY_NAME).as_str()).exists() {
Ok(format!("/opt/websurfx/{}", PUBLIC_DIRECTORY_NAME))
} else if Path::new(format!("./{}/", PUBLIC_DIRECTORY_NAME).as_str()).exists() {
Ok(format!("./{}", PUBLIC_DIRECTORY_NAME))
} else {
Err(Error::new(
std::io::ErrorKind::NotFound,
"Themes (public) folder not found!!",
))
return Ok(format!("/opt/websurfx/{}", PUBLIC_DIRECTORY_NAME));
}
if Path::new(format!("./{}/", PUBLIC_DIRECTORY_NAME).as_str()).exists() {
return Ok(format!("./{}", PUBLIC_DIRECTORY_NAME));
}
Err(Error::new(
std::io::ErrorKind::NotFound,
"Themes (public) folder not found!!",
))
}

12
src/lib.rs
View File

@ -2,10 +2,10 @@
//! and register all the routes for the `websurfx` meta search engine website.
pub mod cache;
pub mod config_parser;
pub mod config;
pub mod engines;
pub mod handler;
pub mod search_results_handler;
pub mod results;
pub mod server;
use std::net::TcpListener;
@ -14,9 +14,9 @@ use crate::server::routes;
use actix_files as fs;
use actix_web::{dev::Server, middleware::Logger, web, App, HttpServer};
use config_parser::parser::Config;
use config::parser::Config;
use handlebars::Handlebars;
use handler::public_path_handler::handle_different_public_path;
use handler::public_paths::public_path;
/// Runs the web server on the provided TCP listener and returns a `Server` instance.
///
@ -32,7 +32,7 @@ use handler::public_path_handler::handle_different_public_path;
///
/// ```rust
/// use std::net::TcpListener;
/// use websurfx::{config_parser::parser::Config, run};
/// use websurfx::{config::parser::Config, run};
///
/// let config = Config::parse().unwrap();
/// let listener = TcpListener::bind("127.0.0.1:8080").expect("Failed to bind address");
@ -41,7 +41,7 @@ use handler::public_path_handler::handle_different_public_path;
pub fn run(listener: TcpListener, config: Config) -> std::io::Result<Server> {
let mut handlebars: Handlebars = Handlebars::new();
let public_folder_path: String = handle_different_public_path()?;
let public_folder_path: String = public_path()?;
handlebars
.register_templates_directory(".html", format!("{}/templates", public_folder_path))

2
src/search_results_handler/aggregation_models.rs → src/results/aggregation_models.rs
View File

@ -3,7 +3,7 @@
use serde::{Deserialize, Serialize};
use crate::config_parser::parser_models::Style;
use crate::config::parser_models::Style;
/// A named struct to store, serialize and deserializes the individual search result from all the
/// scraped and aggregated search results from the upstream search engines.

0
src/search_results_handler/aggregator.rs → src/results/aggregator.rs
View File

0
src/search_results_handler/mod.rs → src/results/mod.rs
View File

0
src/search_results_handler/user_agent.rs → src/results/user_agent.rs
View File

84
src/server/routes.rs
View File

@ -6,9 +6,9 @@ use std::fs::read_to_string;
use crate::{
cache::cacher::RedisCache,
config_parser::parser::Config,
handler::public_path_handler::handle_different_public_path,
search_results_handler::{aggregation_models::SearchResults, aggregator::aggregate},
config::parser::Config,
handler::public_paths::public_path,
results::{aggregation_models::SearchResults, aggregator::aggregate},
};
use actix_web::{get, web, HttpRequest, HttpResponse};
use handlebars::Handlebars;
@ -73,46 +73,25 @@ pub async fn search(
) -> Result<HttpResponse, Box<dyn std::error::Error>> {
let params = web::Query::<SearchParams>::from_query(req.query_string())?;
//Initialize redis cache connection struct
let mut redis_cache = RedisCache::new(config.redis_connection_url.clone())?;
match &params.q {
Some(query) => {
if query.trim().is_empty() {
Ok(HttpResponse::Found()
return Ok(HttpResponse::Found()
.insert_header(("location", "/"))
.finish())
} else {
let page = match &params.page {
Some(page) => *page,
None => 0,
};
let page_url = format!(
"http://{}:{}/search?q={}&page={}",
config.binding_ip_addr, config.port, query, page
);
// fetch the cached results json.
let cached_results_json = redis_cache.cached_results_json(&page_url);
// check if fetched results was indeed fetched or it was an error and if so
// handle the data accordingly.
match cached_results_json {
Ok(results_json) => {
let new_results_json: SearchResults = serde_json::from_str(&results_json)?;
let page_content: String = hbs.render("search", &new_results_json)?;
Ok(HttpResponse::Ok().body(page_content))
}
Err(_) => {
let mut results_json: crate::search_results_handler::aggregation_models::SearchResults =
aggregate(query, page, config.aggregator.random_delay, config.debug).await?;
results_json.add_style(config.style.clone());
redis_cache
.cache_results(serde_json::to_string(&results_json)?, &page_url)?;
let page_content: String = hbs.render("search", &results_json)?;
Ok(HttpResponse::Ok().body(page_content))
}
}
.finish());
}
let page = match &params.page {
Some(page) => *page,
None => 0,
};
let url = format!(
"http://{}:{}/search?q={}&page={}",
config.binding_ip, config.port, query, page
);
let results_json = results(url, &config, query, page).await?;
let page_content: String = hbs.render("search", &results_json)?;
Ok(HttpResponse::Ok().body(page_content))
}
None => Ok(HttpResponse::Found()
.insert_header(("location", "/"))
@ -120,11 +99,36 @@ pub async fn search(
}
}
/// Fetches the results for a query and page.
/// First checks the redis cache, if that fails it gets proper results
async fn results(
url: String,
config: &Config,
query: &str,
page: u32,
) -> Result<SearchResults, Box<dyn std::error::Error>> {
//Initialize redis cache connection struct
let mut redis_cache = RedisCache::new(config.redis_url.clone())?;
// fetch the cached results json.
let cached_results_json = redis_cache.cached_json(&url);
// check if fetched results was indeed fetched or it was an error and if so
// handle the data accordingly.
match cached_results_json {
Ok(results_json) => Ok(serde_json::from_str::<SearchResults>(&results_json).unwrap()),
Err(_) => {
let mut results_json: crate::results::aggregation_models::SearchResults =
aggregate(query, page, config.aggregator.random_delay, config.debug).await?;
results_json.add_style(config.style.clone());
redis_cache.cache_results(serde_json::to_string(&results_json)?, &url)?;
Ok(results_json)
}
}
}
/// Handles the route of robots.txt page of the `websurfx` meta search engine website.
#[get("/robots.txt")]
pub async fn robots_data(_req: HttpRequest) -> Result<HttpResponse, Box<dyn std::error::Error>> {
let page_content: String =
read_to_string(format!("{}/robots.txt", handle_different_public_path()?))?;
let page_content: String = read_to_string(format!("{}/robots.txt", public_path()?))?;
Ok(HttpResponse::Ok()
.content_type("text/plain; charset=ascii")
.body(page_content))

4
tests/index.rs
View File

@ -1,7 +1,7 @@
use std::net::TcpListener;
use handlebars::Handlebars;
use websurfx::{config_parser::parser::Config, run};
use websurfx::{config::parser::Config, run};
// Starts a new instance of the HTTP server, bound to a random available port
fn spawn_app() -> String {
@ -41,5 +41,5 @@ async fn test_index() {
assert_eq!(res.text().await.unwrap(), template);
}
// TODO: Write tests for tesing parameters for search function that if provided with something
// TODO: Write tests for testing parameters for search function that if provided with something
// other than u32 like alphabets and special characters than it should panic

4
websurfx/config.lua
View File

@ -4,7 +4,7 @@ debug = false -- an option to enable or disable debug mode.
-- ### Server ###
port = "8080" -- port on which server should be launched
binding_ip_addr = "127.0.0.1" --ip address on the which server should be launched.
binding_ip = "127.0.0.1" --ip address on the which server should be launched.
production_use = false -- whether to use production mode or not (in other words this option should be used if it is to be used to host it on the server to provide a service to a large number of users)
-- if production_use is set to true
-- There will be a random delay before sending the request to the search engines, this is to prevent DDoSing the upstream search engines from a large number of simultaneous requests.
@ -25,4 +25,4 @@ colorscheme = "catppuccin-mocha" -- the colorscheme name which should be used fo
theme = "simple" -- the theme name which should be used for the website
-- ### Caching ###
redis_connection_url = "redis://127.0.0.1:8082" -- redis connection url address on which the client should connect on.
redis_url = "redis://127.0.0.1:8082" -- redis connection url address on which the client should connect on.