Merge branch 'main' into follow-remote-ids

.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: bookwrym
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

README.md

@@ -8,6 +8,7 @@ Social reading and reviewing, decentralized with ActivityPub
    - [The role of federation](#the-role-of-federation)
    - [Features](#features)
  - [Setting up the developer environment](#setting-up-the-developer-environment)
+ - [Installing in Production](#installing-in-production)
  - [Project structure](#project-structure)
  - [Book data](#book-data)
  - [Contributing](#contributing)
@@ -114,7 +115,7 @@ This project is still young and isn't, at the momoment, very stable, so please p
   `cp .env.example .env`
    - Add your domain, email address, mailgun credentials
    - Set a secure redis password and secret key
- - Update your nginx configuration in `nginx/defautl.conf`
+ - Update your nginx configuration in `nginx/default.conf`
    - Replace `your-domain.com` with your domain name
  - Run the application (this should also set up a Certbot ssl cert for your domain)
   `docker-compose up --build`
@@ -124,13 +125,13 @@ This project is still young and isn't, at the momoment, very stable, so please p
  - Run docker-compose in the background
   `docker-compose up -d`
  - Initialize the database
-  `./fr-dev initdb`
+  `./bw-dev initdb`
  - Congrats! You did it, go to your domain and enjoy the fruits of your labors
 ### Configure your instance
  - Register a user account in the applcation UI
  - Make your account a superuser (warning: do *not* use django's `createsuperuser` command)
    - On your server, open the django shell
-    `./fr-dev shell`
+    `./bw-dev shell`
    - Load your user and make it a superuser
     ```python
     from bookwyrm import models

bookwyrm/context_processors.py

@@ -0,0 +1,8 @@
+''' customize the info available in context for rendering templates '''
+from bookwyrm import models
+
+def site_settings(request):
+    ''' include the custom info about the site '''
+    return {
+        'site': models.SiteSettings.objects.get()
+    }

bookwyrm/migrations/0016_auto_20201211_2026.py

@@ -0,0 +1,28 @@
+# Generated by Django 3.0.7 on 2020-12-11 20:26
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('bookwyrm', '0015_auto_20201128_0349'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='sitesettings',
+            name='admin_email',
+            field=models.EmailField(blank=True, max_length=255, null=True),
+        ),
+        migrations.AddField(
+            model_name='sitesettings',
+            name='support_link',
+            field=models.CharField(blank=True, max_length=255, null=True),
+        ),
+        migrations.AddField(
+            model_name='sitesettings',
+            name='support_title',
+            field=models.CharField(blank=True, max_length=100, null=True),
+        ),
+    ]

bookwyrm/models/site.py

@@ -17,6 +17,9 @@ class SiteSettings(models.Model):
     code_of_conduct = models.TextField(
         default="Add a code of conduct here.")
     allow_registration = models.BooleanField(default=True)
+    support_link = models.CharField(max_length=255, null=True, blank=True)
+    support_title = models.CharField(max_length=100, null=True, blank=True)
+    admin_email = models.EmailField(max_length=255, null=True, blank=True)
 
     @classmethod
     def get(cls):

bookwyrm/settings.py

@@ -15,6 +15,13 @@ CELERY_ACCEPT_CONTENT = ['application/json']
 CELERY_TASK_SERIALIZER = 'json'
 CELERY_RESULT_SERIALIZER = 'json'
 
+# email
+EMAIL_HOST = env('EMAIL_HOST')
+EMAIL_PORT = env('EMAIL_PORT', 587)
+EMAIL_HOST_USER = env('EMAIL_HOST_USER')
+EMAIL_HOST_PASSWORD = env('EMAIL_HOST_PASSWORD')
+EMAIL_USE_TLS = env('EMAIL_USE_TLS', True)
+
 # Build paths inside the project like this: os.path.join(BASE_DIR, ...)
 BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
 
@@ -68,6 +75,7 @@ TEMPLATES = [
                 'django.template.context_processors.request',
                 'django.contrib.auth.context_processors.auth',
                 'django.contrib.messages.context_processors.messages',
+                'bookwyrm.context_processors.site_settings',
             ],
         },
     },

bookwyrm/templates/about.html

@@ -3,13 +3,13 @@
 
 <div class="columns">
     <div class="column block">
-        {% include 'snippets/about.html' with site_settings=site_settings %}
+        {% include 'snippets/about.html' %}
     </div>
 
     <div class="column block">
         <h2 class="title">Code of Conduct</h2>
         <div class="content">
-            {{ site_settings.code_of_conduct | safe }}
+            {{ site.code_of_conduct | safe }}
         </div>
     </div>
 </div>

bookwyrm/templates/invite.html

@@ -15,7 +15,7 @@
     </div>
     <div class="column">
         <div class="block">
-            {% include 'snippets/about.html' with site_settings=site_settings %}
+            {% include 'snippets/about.html' %}
         </div>
     </div>
 </div>

bookwyrm/templates/layout.html

@@ -2,7 +2,7 @@
 <!DOCTYPE html>
 <html lang="en">
 <head>
-    <title>{% if title %}{{ title }} | {% endif %}BookWyrm</title>
+    <title>{% if title %}{{ title }} | {% endif %}{{ site.name }}</title>
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <link type="text/css" rel="stylesheet" href="/static/css/bulma.min.css">
     <link type="text/css" rel="stylesheet" href="/static/css/format.css">
@@ -11,12 +11,10 @@
     <link rel="shortcut icon" type="image/x-icon" href="/static/images/favicon.ico">
 
     <meta name="twitter:card" content="summary">
-    <meta name="twitter:title" content="BookWyrm">
-    <meta name="og:title" content="BookWyrm">
+    <meta name="twitter:title" content="{{ site.name }}">
+    <meta name="og:title" content="{{ site.name }}">
     <meta name="twitter:description" content="Federated Social Reading">
     <meta name="og:description" content="Federated Social Reading">
-    <meta name="twitter:creator" content="@tripofmice">
-    <meta name="twitter:site" content="@tripofmice">
 </head>
 <body>
 
@@ -123,6 +121,30 @@
     {% endblock %}
 </div>
 
+<div class="footer">
+    <div class="columns">
+        <div class="column">
+            <p>
+                <a href="/about">About this server</a>
+            </p>
+            {% if site.admin_email %}
+            <p>
+                <a href="mailto:{{ site.admin_email }}">Contact site admin</a>
+            </p>
+            {% endif %}
+        </div>
+        {% if site.support_link %}
+        <div class="column">
+            <span class="icon icon-heart"></span>
+            Support {{ site.name }} on <a href="{{ site.support_link }}" target="_blank">{{ site.support_title }}</a>
+        </div>
+        {% endif %}
+        <div class="column">
+            BookWyrm is open source software. You can contribute or report issues on <a href="https://github.com/mouse-reeve/bookwyrm">GitHub</a>.
+        </div>
+    </div>
+</div>
+
 <script>
     var csrf_token = '{{ csrf_token }}';
 </script>

bookwyrm/templates/login.html

@@ -30,13 +30,13 @@
                         <button class="button is-primary" type="submit">Log in</button>
                     </div>
                     <div class="control">
-                        <small><a href="/reset-password">Forgot your password?</a></small>
+                        <small><a href="/password-reset">Forgot your password?</a></small>
                     </div>
                 </div>
             </form>
         </div>
         <div class="box has-background-primary-light">
-            {% if site_settings.allow_registration %}
+            {% if site.allow_registration %}
             <h2 class="title">Create an Account</h2>
             <form name="register" method="post" action="/user-register">
                 {% include 'snippets/register_form.html' %}
@@ -50,7 +50,7 @@
 
     <div class="column">
         <div class="block">
-            {% include 'snippets/about.html' with site_settings=site_settings %}
+            {% include 'snippets/about.html' %}
 
             <p class="block">
                 <a href="/about/">More about this site</a>

bookwyrm/templates/notifications.html

@@ -1,5 +1,6 @@
 {% extends 'layout.html' %}
-{% load humanize %}l
+{% load humanize %}
+{% load fr_display %}
 {% block content %}
 <div class="block">
     <h1 class="title">Notifications</h1>
@@ -12,9 +13,10 @@
 
 <div class="block">
     {% for notification in notifications %}
-    <div class="notification level{% if notification.id in unread %} is-primary{% endif %}">
-        <div class="level-left">
+    <div class="notification {% if notification.id in unread %} is-primary{% endif %}">
+        <div class="block">
             <p>
+                {# DESCRIPTION #}
                 {% if notification.related_user %}
                 {% include 'snippets/avatar.html' with user=notification.related_user %}
                 {% include 'snippets/username.html' with user=notification.related_user %}
@@ -30,10 +32,8 @@
                     <a href="{{ notification.related_status.remote_id}}">replied</a>
                     to your
                     <a href="{{ notification.related_status.reply_parent.remote_id}}">status</a>
-
                 {% elif notification.notification_type == 'FOLLOW' %}
                     followed you
-
                 {% elif notification.notification_type == 'FOLLOW_REQUEST' %}
                     sent you a follow request
                     <div class="row shrink">
@@ -45,17 +45,30 @@
                 {% endif %}
                 {% else %}
                     your <a href="/import-status/{{ notification.related_import.id }}">import</a> completed.
-
                 {% endif %}
             </p>
         </div>
-
-        <p class="level-right">{{ notification.created_date | naturaltime }}</p>
+        {% if notification.related_status %}
+        <div class="block">
+            {# PREVIEW #}
+            <div class="notification py-2 {% if notification.id in unread %}is-primary is-light{% else %}has-background-white{% if notification.notification_type == 'REPLY' or notification.notification_type == 'MENTION' %} has-text-black{% else %}-bis has-text-grey-dark{% endif %}{% endif %}">
+                <div class="columns">
+                    <div class="column">
+                        <a href="{{ notification.related_status.remote_id }}">{{ notification.related_status.content | truncatewords_html:10 }}</a>
+                    </div>
+                    <div class="column is-narrow {% if notification.notification_type == 'REPLY' or notification.notification_type == 'MENTION' %}has-text-black{% else %}has-text-grey-dark{% endif %}">
+                        {{ notification.related_status.published_date | post_date }}
+                        {% include 'snippets/privacy-icons.html' with item=notification.related_status %}
+                    </div>
+                </div>
+            </div>
+        </div>
+        {% endif %}
     </div>
     {% endfor %}
+
     {% if not notifications %}
     <p>You're all caught up!</p>
     {% endif %}
 </div>
-
 {% endblock %}

bookwyrm/templates/password_reset.html

@@ -34,7 +34,7 @@
 
     <div class="column">
         <div class="block">
-            {% include 'snippets/about.html' with site_settings=site_settings %}
+            {% include 'snippets/about.html' %}
         </div>
     </div>
 

bookwyrm/templates/snippets/about.html

@@ -1,7 +1,7 @@
-<h1 class="title">About {{ site_settings.name }}</h1>
+<h1 class="title">About {{ site.name }}</h1>
 <div class="block">
     <img src="/static/images/logo.png" alt="BookWyrm">
 </div>
 <p class="block">
-    {{ site_settings.instance_description }}
+    {{ site.instance_description }}
 </p>

bookwyrm/urls.py

@@ -6,8 +6,8 @@ from django.urls import path, re_path
 from bookwyrm import incoming, outgoing, views, settings, wellknown
 from bookwyrm import view_actions as actions
 
-username_regex = r'(?P<username>[\w\-_]+@[\w\-\_\.]+)'
-localname_regex = r'(?P<username>[\w\-_]+)'
+username_regex = r'(?P<username>[\w\-_\.]+@[\w\-\_\.]+)'
+localname_regex = r'(?P<username>[\w\-_\.]+)'
 user_path = r'^user/%s' % username_regex
 local_user_path = r'^user/%s' % localname_regex
 
@@ -61,8 +61,8 @@ urlpatterns = [
     # should return a ui view or activitypub json blob as requested
     # users
     re_path(r'%s/?$' % user_path, views.user_page),
-    re_path(r'%s/?$' % local_user_path, views.user_page),
     re_path(r'%s\.json$' % local_user_path, views.user_page),
+    re_path(r'%s/?$' % local_user_path, views.user_page),
     re_path(r'%s/shelves/?$' % local_user_path, views.user_shelves_page),
     re_path(r'%s/followers(.json)?/?$' % local_user_path, views.followers_page),
     re_path(r'%s/following(.json)?/?$' % local_user_path, views.following_page),

bookwyrm/view_actions.py

@@ -42,7 +42,6 @@ def user_login(request):
     login_form.non_field_errors = 'Username or password are incorrect'
     register_form = forms.RegisterForm()
     data = {
-        'site_settings': models.SiteSettings.get(),
         'login_form': login_form,
         'register_form': register_form
     }
@@ -78,7 +77,6 @@ def register(request):
 
     if errors:
         data = {
-            'site_settings': models.SiteSettings.get(),
             'login_form': forms.LoginForm(),
             'register_form': form
         }

bookwyrm/views.py

@@ -130,7 +130,7 @@ def get_activity_feed(user, filter_level, model=models.Status):
         activities = model.objects
 
     activities = activities.filter(
-        deleted=False
+        deleted=False,
     ).order_by(
         '-published_date'
     )
@@ -159,6 +159,11 @@ def get_activity_feed(user, filter_level, model=models.Status):
             Q(user__in=following, privacy='followers') | Q(privacy='public')
         )
 
+    try:
+        activities = activities.filter(~Q(boosters__in=activities))
+    except ValueError:
+        pass
+
     return activities
 
 
@@ -234,7 +239,6 @@ def login_page(request):
     # send user to the login page
     data = {
         'title': 'Login',
-        'site_settings': models.SiteSettings.get(),
         'login_form': forms.LoginForm(),
         'register_form': forms.RegisterForm(),
     }
@@ -246,7 +250,6 @@ def about_page(request):
     ''' more information about the instance '''
     data = {
         'title': 'About',
-        'site_settings': models.SiteSettings.get(),
     }
     return TemplateResponse(request, 'about.html', data)
 
@@ -294,7 +297,6 @@ def invite_page(request, code):
 
     data = {
         'title': 'Join',
-        'site_settings': models.SiteSettings.get(),
         'register_form': forms.RegisterForm(),
         'invite': invite,
     }