def series(request, series: str):
    series_articles = Article.objects.filter(series__series_slug=series).all()
    return render(request, 'main/home.html', context={'objects': series_articles})

urlpatterns = [
     # 2) Django then looks here and sees to look for views.homepage view
    path('', views.homepage, name='homepage'),
    # now create a new url patter with a path to the series
    path('<series>', views.series, name='series'),
    # Add the path for rendering the articles: This means I have to create a articles view
    path('<series>/<article>', views.article, name='article'),
]

...

    # I need to create a method that creates a slug field and use property decorator
    @property
    def slug(self):
        return self.series.series_slug + '/' + self.article_slug

# First I need to go to the models.py file where I created the slug method
# with a @property decorator and join series_slug with article_slug

def article(request, series: str, article: str):
    matching_article = Article.objects.filter(series__series_slug=series, article_slug=article).first() # instead of all get first instance
    return render(request, 'main/article.html', context={'object': matching_article})

from django.forms import forms
from django.contrib.auth.forms import UserCreationForm
from django.contrib.auth import get_user_model



class UserRegistrationForm(UserCreationForm):
    email = forms.EmailField(help_text="A valid email address required")

    class Meta:
        model = get_user_model()
        fields = ['first_name', 'last_name', 'username', 'email', 'password1', 'password2']

    def save(self, commit=True):
        user = super(UserRegistrationForm, self).save(commit=False)
        user.email = self.cleaned_data['email']
        if commit:
            user.save()

        return user

from django.shortcuts import render, redirect
from django.contrib.auth import get_user_model, login
from .forms import UserRegistrationForm


# Create your views here.
def register(request):

    if request.user.is_authenticated:
        return redirect('/')

    if request.method == 'POST':
        # check if form is valid
        form = UserRegistrationForm(request.POST)
        if form.is_valid():
            user = form.save()
            login(request, user)
            return redirect('/')

        else:
            for error in list(form.errors.values()):
                print(request, error)

    else:
        form = UserRegistrationForm()

    return render(request, 'registeration.html', {'form': form})

from django.shortcuts import render, redirect
from django.contrib.auth import get_user_model, login
# ===== NEW IMPORT TO THIS FILE ====== #
from django.contrib import messages
# ==================================== #
from django.contrib.auth.decorators import wraps, resolve_url
from .forms import UserRegistrationForm


# Create your views here.
def register(request):
    # Check if the user is logged in already or not:
    if request.user.is_authenticated:
        # if user is already logged in, send them to homepage
        return redirect('/')
    # Check if the request method equals POST
    if request.method == "POST":
        # create a form variable and feed it the request.POST submission
        form = UserRegistrationForm(request.POST)
        # then check if form is valid
        if form.is_valid():
            # if form is valid save it and then login to the account and get redirected to homepage
            user = form.save()
            login(request, user)
            messages.success(request, f"New account created: {user.username}")
            return redirect('/')

        else:
            for error in list(form.errors.values()):
                messages.error(request, error)

    else:
        form = UserRegistrationForm()

    return render(
        request=request,
        template_name = "users/register.html",
        context={"form": form}
        )

from django.urls import path
from . import views
# ============================================================================================ #
# THIS WAS IMPORTED FOR THE BELOW URLPATTERNS
from django.contrib.auth import views as auth_views


urlpatterns = [
    path("register/", views.register, name="register"),
    # ============================================================================================ #
    # THESE ARE THE ADDED URLS: 
    # ============================================================================================ #
    # Now create my new login and logout paths:
    path('login', auth_views.LoginView.as_view(template_name='users/login.html'), name='login'),
    path('logout', auth_views.LogoutView.as_view(template_name='users/logout.html'), name='logout'),
]

from django.shortcuts import redirect


# Create a basic function for user not authenticated
def user_not_authenticated(function=None, redirect_url='/'):
    """
    :description: The main purpose of this decorator function is check if the user 
    is authenticated or not. If the user is authenticated then we need to redirect
    the user back to specified url. (USuaully Homepage) 

    :param functions: 

    :param redirect_url:
    """

    # Now create another function inside this function called decorator
    def decorator(view_func):
        # and then one more function called _wrapped_view
        def _wrapped_view(request, *args, **kwargs):
            # This will return the user to the homepage if the user is authenticated
            if request.user.is_authenticated:
                return redirect(redirect_url)

            # but if the above check doesn't work, we still need to return something. 
            # in this case it will be the view function
            return  view_func(request, *args, **kwargs)

        return _wrapped_view

    if function: # is not None
        # then return the decorator function that you want to use
        return decorator(function)

    return decorator

from django.shortcuts import render, redirect
from django.contrib.auth import get_user_model, login, logout, authenticate
from django.contrib import messages
from .forms import UserRegistrationForm
from django.contrib.auth.decorators import login_required
from django.contrib.auth.forms import AuthenticationForm

from .decorators import user_not_authenticated

# Create your views here.
@user_not_authenticated
def register(request):
    # BELOW CODE IS REPLACED BY THE DECORATOR FUNCTION
    # ============================================================================== #
    # # Check if the user is logged in already or not:
    # if request.user.is_authenticated:
    #     # if user is already logged in, send them to homepage
    #     return redirect('/')
    # ============================================================================== #
    # Check if the request method equals POST
    if request.method == "POST":
        # create a form variable and feed it the request.POST submission
        form = UserRegistrationForm(request.POST)
        # then check if form is valid
        if form.is_valid():
            # if form is valid save it and then login to the account and get redirected to homepage
            user = form.save()
            login(request, user)
            messages.success(request, f"New account created: {user.username}")
            return redirect('/')

        else:
            for error in list(form.errors.values()):
                messages.error(request, error)

    else:
        form = UserRegistrationForm()

    return render(
        request=request,
        template_name = "users/register.html",
        context={"form": form}
        )

@login_required
def custom_logout(request):
    logout(request)
    messages.info(request, "Logged out successfully!")
    return redirect("homepage")

@user_not_authenticated
def custom_login(request):
    # BELOW CODE IS REPLACED BY THE DECORATOR FUNCTION
    # ============================================================================== #
    # if request.user.is_authenticated:
    #     return redirect("homepage")
    # ============================================================================== #

    if request.method == "POST":
        form = AuthenticationForm(request=request, data=request.POST)
        if form.is_valid():
            user = authenticate(
                username=form.cleaned_data["username"],
                password=form.cleaned_data["password"],
            )
            if user is not None:
                login(request, user)
                messages.success(request, f"Hello <b>{user.username}</b>! You have been logged in!")
                return redirect("homepage")
        
        else:
            for error in list(form.errors.values()):
                messages.error(request, error)

    form = AuthenticationForm()

    return render(
        request=request,
        template_name="users/login.html",
        context={"form": form},
    )

from django import forms
from django.contrib.auth.forms import UserCreationForm, AuthenticationForm # <---- ADDED THE AuthenticationForm import as well
from django.contrib.auth import get_user_model


class UserRegistrationForm(UserCreationForm):
    email = forms.EmailField(help_text='A valid email address, please.', required=True)

    class Meta:
        model = get_user_model()
        fields = ['first_name', 'last_name', 'username', 'email', 'password1', 'password2']

    def save(self, commit=True):
        user = super(UserRegistrationForm, self).save(commit=False)
        user.email = self.cleaned_data['email']
        if commit:
            user.save()

        return user

# ======================================================================================== #
# ADDED THIS NEW USER LOGIN FORM OBJECT
# ======================================================================================== #
class UserLoginForm(AuthenticationForm):

    def __init__(self,*args, **kwargs):
        super(UserLoginForm, self).__init__(*args, **kwargs)

    username = forms.CharField(
        widget=forms.TextInput(
            attrs={'class': 'form-control', 'placeholder': 'Username of Email'}),
            label="Username or Email")

    password = forms.CharField(
        widget=forms.PasswordInput(
            attrs={'class': 'form-control', 'placeholder': 'Password'}))

from django.contrib.auth.backends import ModelBackend
from django.contrib.auth import get_user_model
from django.db.models import Q

UserModel = get_user_model()
class EmailBackend(ModelBackend):
    """
    Authenticates against settings.AUTH_USER_MODEL.
    """

    def authenticate(self, request, username=None, password=None, **kwargs):
        try: 
            # This basically queries the database in search of a match for the username or email
            user = UserModel.objects.get(Q(username__iexact=username) | Q(email__iexact=username))

        # Now I need to create an exception incase there is no such username or email in the database:
        except UserModel.DoesNotExist:
            UserModel().set_password(password)
            return

        except UserModel.MultipleObjectsReturned:
            user = UserModel.objects.get(Q(username__iexact=username) | Q(email__iexact=username)).order_by('id').first()

        if user.check_password(password) and self.user_can_authenticate(user):
            return user

# Adding the backend authentication setting that I created for the EmailBackend object
AUTHENTICATION_BACKENDS = ['users.backends.EmailBackend']

...
# THIS NEED TO BE IMPORTED TO THE SCRIPT
from captcha.fields import ReCaptchaField
from captcha.widgets import ReCaptchaV2Checkbox
...


class UserLoginForm(AuthenticationForm):

    def __init__(self,*args, **kwargs):
        super(UserLoginForm, self).__init__(*args, **kwargs)

    username = forms.CharField(
        widget=forms.TextInput(
            attrs={'class': 'form-control', 'placeholder': 'Username of Email'}),
            label="Username or Email")

    password = forms.CharField(
        widget=forms.PasswordInput(
            attrs={'class': 'form-control', 'placeholder': 'Password'}))

    # ================================================================================= #
    # THIS IS WHAT WAS ADDED FOR THE reCAPTCHA FIELD
    # ================================================================================= #
    captcha = ReCaptchaField(widget=ReCaptchaV2Checkbox(attrs={'data-theme': 'dark'}))

# ADDING THE RECAPTCHA SETTINGS:
RECAPTCHA_PUBLIC_KEY = '6Lc09nchAAAAAPzFjaRfenIGDOYgHr3X1uqgzBKX'
RECAPTCHA_PRIVATE_KEY = '6Lc09nchAAAAAF9qc3Rx0sXOgrbni9eU4XEHNRFr'
# I have to add this to the development version
SILENCED_SYSTEM_CHECKS = ['captcha.recaptcha_test_key_error']

@user_not_authenticated 
def custom_login(request):

    if request.method == "POST":
        form = UserLoginForm(request=request, data=request.POST)
        if form.is_valid():
            user = authenticate(
                username=form.cleaned_data["username"],
                password=form.cleaned_data["password"],
            )
            if user is not None:
                login(request, user)
                messages.success(request, f"Hello <b>{user.username}</b>! You have been logged in!")
                return redirect("homepage")
        
        else:
            # ================================================================================================ #
            # THIS IS THE NEW ELSE CLAUSE FOR HANDLING ERROR MESSAGES
            # ================================================================================================ #
            for key, error in list(form.errors.items()):
                if key == 'captcha' and error[0] == 'This field is required.':
                    messages.error(request, "You must pass the reCAPTCHA test!")
                    continue
                messages.error(request, error)
            # ================================================================================================ #
            # OLD VERSION:
            # ================================================================================================ #
            # for error in list(form.errors.values()):
            #     messages.error(request, error)

            # ================================================================================================ #

    form = UserLoginForm()

    return render(
        request=request,
        template_name="users/login.html",
        context={"form": form},
    )

...

urlpatterns = [
    path("register/", views.register, name="register"),
    path('login/', views.custom_login, name="login"),
    path('logout/', views.custom_logout, name="logout"),
    # ========================================================= #
    # THE NEW URL PATTERN FOR PROFILES
    # ========================================================= #
    path('profile/<username>/', views.profile, name="profile"),
]

...

class UserUpdateForm(forms.ModelForm):
    
    email = forms.EmailField()

    class Meta:
        model = get_user_model()
        fields = ['first_name', 'last_name', 'email', 'description']

# CREATING THE MEDIA URL MANAGER
MEDIA_URL = os.path.join(BASE_DIR, 'media/')

from django.db import models
from django.utils import timezone
# in order to use the tinymce app in my website models, I have to import it into models
# and then change the textfields that I want to use this app to HTMLField
from tinymce.models import HTMLField
from django.contrib.auth import get_user_model

from django.template.defaultfilters import slugify
import os


class ArticleSeries(models.Model):
    ###############################################################################################################
    # UPDATED VERSION OF IMAGE
    # ----------------------------------------------------------------------------------------------------------- #
    def image_upload_to(self, instance=None):
        if instance:
            return os.path.join("ArticleSeries", slugify(self.slug), instance)
        return None
    # ----------------------------------------------------------------------------------------------------------- #

    title = models.CharField(max_length=150)
    subtitle = models.CharField(max_length=255, default="", blank=True)
    slug = models.SlugField('Series slug', null=False, blank=False, unique=True)
    publish_date = models.DateTimeField("Date Published", default=timezone.now)
    ###############################################################################################################
    # UPDATES
    # ----------------------------------------------------------------------------------------------------------- #
    author = models.ForeignKey(get_user_model(), default=1, on_delete=models.SET_DEFAULT)
    image = models.ImageField(default='default/no_image_available.png', max_length=255, upload_to=image_upload_to)
    # ----------------------------------------------------------------------------------------------------------- #

    def __str__(self):
        return self.title

    class Meta:
        verbose_name_plural = 'Series'
        ordering = ['-publish_date']

class Article(models.Model):
    ###############################################################################################################
    # UPDATED upload_to FOR ARTICLE
    # ----------------------------------------------------------------------------------------------------------- #
    def image_upload_to(self, instance=None):
        if instance:
            return os.path.join("ArticleSeries", slugify(self.series.slug), slugify(self.article_slug), instance)
        return None
    # ----------------------------------------------------------------------------------------------------------- #

    title = models.CharField(max_length=150)
    subtitle = models.CharField(max_length=255, default="", blank=True)
    article_slug = models.SlugField('Article slug', null=False, blank=False, unique=True)
    content = HTMLField(blank=True, default="")
    # create a new field for notes then add it to the admin.py files fieldset
    notes = HTMLField(blank=True, default="")
    publish_date = models.DateTimeField("Date Published", default=timezone.now)
    modified = models.DateTimeField("Date Modified", default=timezone.now)
    series = models.ForeignKey(ArticleSeries, default='', verbose_name='Series', on_delete=models.SET_DEFAULT)
    ###############################################################################################################
    # UPDATES
    # ----------------------------------------------------------------------------------------------------------- #
    author = models.ForeignKey(get_user_model(), default=1, on_delete=models.SET_DEFAULT)
    image = models.ImageField(default='default/no_image_available.png', max_length=255, upload_to=image_upload_to)
    # ----------------------------------------------------------------------------------------------------------- #

    # Create a __str__ method
    def __str__(self):
        return self.title

    # I need to create a method that creates a slug field and use property decorator
    @property
    def slug(self):
        return self.series.slug + '/' + self.article_slug

    class Meta:
        verbose_name_plural = "Article"
        ordering = ['-publish_date']