Merge pull request #46 from seanboyce/dev

New release

Author: seanboyce

Dockerfile

@@ -11,12 +11,14 @@ RUN mkdir /app
 
 WORKDIR /app
 
-COPY . .
+COPY ./requirements.txt ./
 
 RUN \
   cd /app && \
   pip install -r requirements.txt --break-system-packages
 
+COPY . .
+
 RUN chmod +x entrypoint.sh
 
 ENV SECRET_KEY_FILE="/app/config/secret_key.txt"

README.md

@@ -2,40 +2,41 @@
 
 uBiblio is a small and fast web application to help you manage your personal library (and share it with friends, or form a book club). It provides a unified interface for both physical books and ebooks. It is free, open-source, designed for self-hosting, and will never contain ads or spy on you.
 
-You don't have to connect it to the Internet. It can run on your LAN. Or even on a single computer with no network access at all. 
+You don't have to connect it to the Internet. It can run on your LAN. Or even on a single computer with no network access at all. If you do connect it to the Internet though, it supports federated inter-library search!
 
 # Main Features:
 
-1. Add, remove, update books
-2. Search books and see their location (useful if stored in bins, because you don't have space for tons of bookshelves)
+1. Add, remove, update and search books. Physical and ebook management.
+2. User management! Admins can invite new users via one-time-use link.
 3. Autopopulate a book's fields by entering an ISBN, either manually or with your device's camera!
-4. Reading list management for each user
-5. Book wishlist (just set owned=False, then update to True when you buy it)
-6. Withdraw and return books. Display a list of withdrawn books (to help put them away or figure out who has them).
-7. Admin users can access all features. Non-admin can only search, manage their reading list, and withdraw/return books.
-8. Content discovery (browse by genre).
-9. Works on most phones and ebook readers.
-10. Really quite fast, low memory requirements for hosting (~100MB). 
-11. No distractions -- it does what it needs to do and nothing else (by default).
-12. Docker, Docker Hub image, and no-container install options. A big thanks to m0ngr31 for helping with this!
-13. Backup management, for both the database and files! 
-14. Ebook support, with the ability to store ebook files and download from your reader (as long as it has a web browser)
-15. You can search for only ebooks or only physical books (e.g. when browsing a physical library vs. from an e-reader)
-16. Optional support for cover / book images (up to 16 for each book), with thumbnail support. You can now judge books by their cover (but only if you want to)!
-17. A luxurious TWO optional custom fields, in case your library is structured differently than mine. Set them up in the admin menu.
-18. It even runs on RISCV64 with memory to spare (check out the cursed branch)!
-19. Aussi disponible en français! Démarrez ubiblio avec LANGUAGE='FR'
+4. Reading list management for each user, and a wishlist for the library (set owned=False)
+5. Withdraw and return books. Display a list of withdrawn books (to help put them away or figure out who has them).
+6. Admin users can access all features. Non-admin can only search, manage their reading list, and withdraw/return books.
+7. Content discovery (browse by genre).
+8. Works on most phones and ebook readers.
+9. Really quite fast, low memory requirements for hosting (~100MB). Simple, distraction-free UI.
+10. Docker, Docker Hub image, and no-container install options. A big thanks to m0ngr31 for helping with this!
+11. Backup management, for both the database and files! 
+12. Optional support for cover / book images (up to 16 for each book), with thumbnail support. You can now judge books by their cover (but only if you want to)!
+13. A luxurious TWO optional custom fields, in case your library is structured differently than mine. Set them up in the admin menu.
+14. It even runs on RISCV64 with memory to spare (check out the cursed branch)!
+15. Aussi disponible en français! Démarrez ubiblio avec LANGUAGE='FR'
 
 # Setup
 
 ![Setup has moved to it's own file to keep things organized](https://github.com/seanboyce/ubiblio/blob/main/SETUP.md)
 
 
 # Possible future features (in no particular order):
-1. Modify content discovery via 'browse by genre' to be more practical for high numbers of books.
-2. Search by a specific location would be nice -- can be another interface.
-3. Limited UI customization -- what fields are displayed on the search results interface. This can easily break mobile compatibility though, but not everyone is using this on their phone, so being able to take advantage of that extra space is fine.
+![Roadmap has moved to it's own file to keep things organized](https://github.com/seanboyce/ubiblio/blob/main/ROADMAP.md)
 
+# Contributing
+
+Raise an issue here on Github explaining the feature you want (or want to add yourself). Then make a PR! If you are using an AI to assist, please let me know (and test first!), and keep the PR size to a minimum so that I can manually review it.
+
+For bug reports, the process is the same. Maybe also include the steps to reproduce it.
+
+Things I especially need help with: testing, getting more scalable language support in, adding in some kind of integrated help or wiki.
 
 # HTML Theme
 The HTML theme is modified from "forty" by HTML5UP (https://html5up.net/). Actually, check out their other themes too. They are excellent and provide the themes under CC Attribution 3.0 (https://html5up.net/license). It's a huge timesaver for building things like this. So please leave the attribution in the footer.

ROADMAP.md

@@ -1,31 +1,32 @@
+This is a file where I list out things I plan to add to uBiblio. You can suggest new things by raising an issue!
+
 # In next release 
 
 1. Barcode Scanning with camera
 2. French Language support 
+3. User creation and management
+4. Some UI fixes
+5. Use local files for barcode scanner and JQuery instead of constantly downloading them
+6. Federated search and viewing book details
 
 # User management
+1. Should there be a 'root' account level? The root account cannot be deleted, and can delete/promote/demote admin accounts.
+2. Still not going to add password recovery. However, might be nice to be able to change my password.
 
-This is long overdue, uBiblio is multi-user but has no user management, making it very hard to use for book clubs and so on.
-
-1. Admins should be able to create a temporary link that lets a new user create a login. For example, they send the link to their friend, and their friend creates an account.
-2. Login links should expire in 24 hrs if unused
-3. There should be a 'root' account level. The owner should be able to set / unset admin rights on user accounts.
-4. Admin and Root are booleans.
-5. Still not going to add password recovery. However, might be nice to be able to change my password.
+# Privacy
+1. Should use local fonts instead of downloading them from google fonts.
 
 # Federation
 
-The goal here is twofold -- first, to allow something like the pre-search-engine inter-library search features of the early 1990s. Second, to make it easier for groups of people, who are perfectly happy running their own libraries, to have better options than merging their databases (although merges are already supported).
+The goal here is twofold -- first, to allow something like the pre-search-engine inter-library search features of the early 1990s. Second, to make it easier for groups of people, who are perfectly happy running their own libraries, to have better options than merging their databases (although merges are already supported). This is a list of unimplemented features related to federation.
+
+1. Maybe offer some expedited way to get a user account -- e.g. request one, and admins get notified on login and can just activate it.
 
-1. Instances of uBiblio should generate a public-private keypair on first launch, and store it in the DB.
-2. The public key will be exposed on an endpoint that requires no login, e.g. /key
-3. If an admin points a ubiblio instance to another (e.g. submits the URL), it will grab the key and store it.
-4. Users should be able to submit book searches to these other instances. This will be an endpoint on their local instance, which will sign the request and pass it to the target.
-5. If uBiblio receives a search request signed by a key that has been authorized, it will serve the search request without requiring a login.
-6. Maybe offer some expedited way to get a user account -- e.g. request one, and admins get notified on login.
-7. It should also be possible to manually add a public key (e.g. to let libraries without a public IP run federated searches)
 
 # Quality of Life
-1. I think I can let people search book databases by title + author, and selecto ne to add. This will help with libraries of very old, pre-ISBN books.
-2. I think I could add a warning when you are adding something that is very probably a duplicate book.
+1. I think I can let people search book databases by title + author, and select one to add. This will help with libraries of very old, pre-ISBN books.
+2. I think I could add a warning when you are adding something that is very probably a duplicate book (but this might be hard).
 3. I need to eventually add a more scalable localization strategy. For just French a new set of templates is fine, but for more languages it will need to be something smarter.
+4. Books should have a 'date added' field.
+5. I should add a library stats page. It will be basic, just count/sum and group_by on different fields, including custom fields.
+6. There should be an 'about' page. By default, it includes some instructions for new users. However, it will also contain some sections designed to be filled out by users if they want, e.g. 'about this library', 'rules', or just 'how to apply for a user account'. This page requires login or federated access.

SETUP.md

@@ -90,10 +90,12 @@ Note that this example above does not enable SSL. It will accept all incoming co
 
 ## Launching with Gunicorn and SSL / HTTPS
 
-gunicorn will launch multiple instances of uvicorn as needed to support even more concurrent users. You need to add the paths to your cert files and choose a port. Certs from letsencrypt are just fine :)
+gunicorn will launch multiple instances of uvicorn as needed to support even more concurrent users. You need to add the paths to your cert files and choose a port. Certs from letsencrypt are just fine!
+
+NEW: uBiblio can also use more than one worker. An example is below.
 
 ```bash
-python -m gunicorn ubiblio.main:app -b 127.0.0.1:8000 -k uvicorn.workers.UvicornWorker --certfile= --keyfile=
+python -m gunicorn ubiblio.main:app -b 127.0.0.1:8000 -k uvicorn.workers.UvicornWorker -t 2 -w 4 --certfile= --keyfile=
 ```
 
 # Password Recovery

static/assets/js/quagga.min.js

@@ -1,13 +1,12 @@
-<!DOCTYPE html>
+<!DOCTYPE html>
 <!--
 	Forty by HTML5 UP
 	html5up.net | @ajlkn
 	Free for personal and commercial use under the CCA 3.0 license (html5up.net/license)
 -->
 <html>
 	<head>
-	<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.7.1/jquery.min.js"></script>
-
+		<script src="{{ url_for('static', path='assets/js/jquery.min.js')}}"></script>
 		<title>uBiblio</title>
 		<meta charset="utf-8" />
 		<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no" />
@@ -40,12 +39,15 @@
 						<nav id="menu">
 							<ul class="links">
 							<li><a href="/">Recherche de livre</a></li>
+							<li><a href="/fedsearch">Recherche avancée</a></li>
 							<li><a href="/genre/">Parcourir par genres</a></li>
 								<li><a href="/wishlist/">Liste de souhaits</a></li>
 							<li><a href="/readingLists">Listes de lecture</a></li>
 								<li><a href="/withdrawn">Livres empruntés</a></li>
 								{% if user.isAdmin %}
-								<li><a href="/config">Admin</a></li>
+								<li><a href="/config">Configuration</a></li>
+								<li><a href="/userManagement">Gestion des Utilisateurs</a></li>
+								<li><a href="/manageVkeys">Fédération</a></li>
 								{% endif %}
 						</ul>
 						<ul class="actions stacked">

templates/FR/base.html

@@ -59,7 +59,12 @@ <h3 style="margin-top:25px;"><strong><u>Couverture(s)</strong></u></h3>
 	<div style= "display:block; clear:both;float:none;">
 	<hr>
 			<h3><strong><u>Emprunt</strong></u></h3>
-			<a style="border:none; margin-right:25px;" href="/withdraw/{{book.id}}"><button>Emprunter</button></a><a style="border:none; margin-right:25px;" href="/return/{{book.id}}"><button>Rendre</button></a>
+				{% if book.withdrawn %}
+<a style="border:none; margin-right:25px;" href="/return/{{book.id}}"><button>Rendre</button></a>
+		{% else %}
+<a style="border:none; margin-right:25px;" href="/withdraw/{{book.id}}"><button>Emprunter</button></a>
+		{% endif %}
+			
      </div>  
 	<div style= "display:block; clear:both;float:none;">
 		<h3 style="margin-top:25px; margin-bottom:0px;"><strong><u>Liste de lecture</strong></u></h3>

templates/FR/bookDetails.html

@@ -1,4 +1,4 @@
-{% extends "base.html" %}
+{% extends "base.html" %}
 {% block main %}
 
 <!-- Banner -->
@@ -20,14 +20,16 @@
 	<input type="checkbox" id="ebookSearch" name="ebookSearch" value="ebook">
   <label for="ebookSearch"> eBooks uniquement</label>
 	<input type="checkbox" id="noEbookSearch" name="noEbookSearch" value="noebook">
-  <label for="noEbookSearch"> Exclure les eBooks</label><br>
+  <label for="noEbookSearch">Exclure les eBooks</label><br>
   <input style ="float:left;" type="submit" value="Rechercher">										
 </form>
 {% if user.isAdmin %}
 <a style ='text-decoration:none !important; border:none;margin-left:25px;' href="/add_book"><button style="margin-bottom:25px;">Ajouter</button></a>
 <a style ='text-decoration:none !important; border:none;margin-left:25px;' href="/scan_isbn"><button style="margin-bottom:25px;">Scan</button></a>	
-{% endif %}
-<h2 style="margin-top:25px; margin-bottom:15px;">Liste des Livres</h2>
+{% else %}
+<br><br>	
+		{% endif %}
+<h2 id="result_count" style="margin-top:25px; margin-bottom:15px;">Liste des Livres</h2>
 
 <div class="container">  
   <table>
@@ -75,9 +77,12 @@ <h2 style="margin-top:25px; margin-bottom:15px;">Liste des Livres</h2>
     var searchEndpoint = "/searchbooks?title="+searchTerm+"&author="+searchTerm+"&skip="+skip+"&onlyEbooks="+onlyEbooks+"&noEbooks="+noEbooks;
 }
 $.post(searchEndpoint,function(data, status){
-    itemdata = jQuery.parseJSON(data);
+    result = jQuery.parseJSON(data);
     $("#tablebody").empty();
     $("#pagination").empty();
+	var count = result.count;
+	document.getElementById("result_count").textContent="Liste des Livres (" + count + ")";
+	var itemdata = jQuery.parseJSON(result.result);
     itemdata.forEach(function(item) {
     $("#tablebody").append('<tr><td><a style = "border:none;text-decoration: underline;" href="/bookDetails/'+item.id+'">'+item.title+"</a></td><td>"+item.author+"</td><td>"+item.shelf+'</td></tr>');
 });
@@ -86,11 +91,11 @@ <h2 style="margin-top:25px; margin-bottom:15px;">Liste des Livres</h2>
         $("#tablebody").append('<tr><td>' + "Aucune résultat" + '</td><td></td><td></td></tr>');
     }
 if (pagination > 0){
-$("#pagination").append("<button onclick='previous();'>Previous</button>");
+$("#pagination").append("<button onclick='previous();'>Précédente</button>");
 }
 
 if(itemdata.length > 49){
-$("#pagination").append("<button onclick='next();'>Next</button>");
+$("#pagination").append("<button onclick='next();'>Suivante</button>");
 }
 
 });}

templates/FR/booksearch.html

@@ -0,0 +1,29 @@
+{% set hideNav = True %}
+{% extends "base.html" %}
+
+{% block main %}
+<!-- Banner -->
+<!-- Two -->
+<section id="two">
+	<div class="inner" style = "padding: 20px 0 1em 0;">
+		<header class="major">
+			<h2>Créer un Compte</h2>
+		</header>
+		{% for error in errors %}
+		    <p style="color: red">{{ error }}</p>
+		{% endfor %}
+		<form action="/auth/create" method="post">
+			<p>
+			    <p><label for="">Nom d'utilisateur</label></p>
+			    <input type="text" name="username" value="" required>
+			</p>
+			<p>
+			    <p><label for="">Mot de passe</label></p>
+			    <input type="password" name="password" value="" required>
+				<input type="hidden" name="accessCode" value="{{ accessCode }}" required>
+			</p>
+			<input type="submit" value="Submit">
+		</form>
+	</div>				
+</section>
+{% endblock %}

templates/FR/createUser.html

@@ -0,0 +1,77 @@
+{% extends "base.html" %}
+{% block main %}
+
+<!-- Banner -->
+	<!-- Two -->
+<div class="inner" style = "padding: 20px 0 5em 5em;">
+<div style="display:block; clear:both; float:none;">
+<h3><strong><u>Détails du livre</strong></u></h3>
+<div style="display:block; clear:both; float:none;">
+<div id = "bookdetails" style="width:30%; min-width: 300px; float:left; margin-right:30px;">								
+
+
+                                </div>
+    <div id = "bookdetails2" style="width:30%; min-width: 280px; float:left;">
+
+
+		</div>
+	
+	<div style= "display:block; clear:both;float:none;">
+		
+<hr>
+
+</div>
+
+</div>
+<script>
+async function search(bookId) {
+var data = JSON.stringify({"bookId": bookId});	
+var xhr = new XMLHttpRequest();
+var url = "/signsearch";
+xhr.open("POST", url, true);
+xhr.setRequestHeader("Content-Type", "application/json");
+xhr.onreadystatechange = function () {
+    if (xhr.readyState === 4 && xhr.status === 200) {
+        signedsearch(JSON.parse(xhr.responseText));
+		
+    }
+};	
+xhr.send(data);	
+}
+	
+function signedsearch(mysearch){
+var xhr = new XMLHttpRequest()
+var url = '{{ vkey.url }}' + "fedBookDetails";
+xhr.open("POST", url, true);
+//xhr.setRequestHeader("Content-Type", "application/json");
+//xhr.setRequestHeader("Access-Control-Allow-Origins", "*");
+//xhr.setRequestHeader("Access-Control-Request-Method", "POST");
+xhr.onreadystatechange = function () {
+    if (xhr.readyState === 4 && xhr.status === 200) {     
+		displayResults(xhr.responseText);
+};		
+};
+var data = JSON.stringify(mysearch);
+xhr.send(data);
+}
+
+function displayResults(results){
+
+    result = jQuery.parseJSON(results);
+    $("#bookdetails").empty();
+	$("#bookdetails2").empty();
+	$("#bookdetails").append('<p><strong>Titre</strong>:'+result["title"]+'</p>');	
+	$("#bookdetails").append('<p><strong>Auteur</strong>:'+result["author"]+'</p>');
+	$("#bookdetails").append('<p><strong>Synopsis</strong>:'+result["summary"]+'</p>');
+	$("#bookdetails").append('<p><strong>Genre</strong>:'+result["genre"]+'</p>');
+	$("#bookdetails").append('<p><strong>Bibliothèque</strong>:'+result["library"]+'</p>');
+	$("#bookdetails").append('<p><strong>Étagère</strong>:'+result["shelf"]+'</p>');
+	$("#bookdetails2").append('<p><strong>Collection</strong>:'+result["collection"]+'</p>');
+	$("#bookdetails2").append('<p><strong>ISBN</strong>:'+result["ISBN"]+'</p>');
+	$("#bookdetails2").append('<p><strong>Notes</strong>:'+result["notes"]+'</p>');
+	$("#bookdetails2").append('<p><strong>Possédé</strong>:'+result["owned"]+'</p>');
+	$("#bookdetails2").append('<p><strong>Emprunté</strong>:'+result["withdrawn"]+'</p>');
+}	
+window.onload = () => search('{{ bookId }}' );
+</script>
+{% endblock %}