Switch to show only favorite tags (BB-94)

boards/abstracts/settingsmanager.py

@@ -1,199 +1,200 b''
 from boards import settings
 from boards.models import Tag
 from boards.models.thread import FAV_THREAD_NO_UPDATES
 
 MAX_TRIPCODE_COLLISIONS = 50
 
 __author__ = 'neko259'
 
 SESSION_SETTING = 'setting'
 
 # Remove this, it is not used any more cause there is a user's permission
 PERMISSION_MODERATE = 'moderator'
 
 SETTING_THEME = 'theme'
 SETTING_FAVORITE_TAGS = 'favorite_tags'
 SETTING_FAVORITE_THREADS = 'favorite_threads'
 SETTING_HIDDEN_TAGS = 'hidden_tags'
 SETTING_PERMISSIONS = 'permissions'
 SETTING_USERNAME = 'username'
 SETTING_LAST_NOTIFICATION_ID = 'last_notification'
 SETTING_IMAGE_VIEWER = 'image_viewer'
 SETTING_TRIPCODE = 'tripcode'
 SETTING_IMAGES = 'images_aliases'
+SETTING_ONLY_FAVORITES = 'only_favorites'
 
 DEFAULT_THEME = 'md'
 
 
 class SettingsManager:
     """
     Base settings manager class. get_setting and set_setting methods should
     be overriden.
     """
     def __init__(self):
         pass
 
     def get_theme(self) -> str:
         theme = self.get_setting(SETTING_THEME)
         if not theme:
             theme = DEFAULT_THEME
             self.set_setting(SETTING_THEME, theme)
 
         return theme
 
     def set_theme(self, theme):
         self.set_setting(SETTING_THEME, theme)
 
     def has_permission(self, permission):
         permissions = self.get_setting(SETTING_PERMISSIONS)
         if permissions:
             return permission in permissions
         else:
             return False
 
     def get_setting(self, setting, default=None):
         pass
 
     def set_setting(self, setting, value):
         pass
 
     def add_permission(self, permission):
         permissions = self.get_setting(SETTING_PERMISSIONS)
         if not permissions:
             permissions = [permission]
         else:
             permissions.append(permission)
         self.set_setting(SETTING_PERMISSIONS, permissions)
 
     def del_permission(self, permission):
         permissions = self.get_setting(SETTING_PERMISSIONS)
         if not permissions:
             permissions = []
         else:
             permissions.remove(permission)
         self.set_setting(SETTING_PERMISSIONS, permissions)
 
     def get_fav_tags(self) -> list:
         tag_names = self.get_setting(SETTING_FAVORITE_TAGS)
         tags = []
         if tag_names:
             tags = list(Tag.objects.filter(name__in=tag_names))
         return tags
 
     def add_fav_tag(self, tag):
         tags = self.get_setting(SETTING_FAVORITE_TAGS)
         if not tags:
             tags = [tag.name]
         else:
             if not tag.name in tags:
                 tags.append(tag.name)
 
         tags.sort()
         self.set_setting(SETTING_FAVORITE_TAGS, tags)
 
     def del_fav_tag(self, tag):
         tags = self.get_setting(SETTING_FAVORITE_TAGS)
         if tag.name in tags:
             tags.remove(tag.name)
             self.set_setting(SETTING_FAVORITE_TAGS, tags)
 
     def get_hidden_tags(self) -> list:
         tag_names = self.get_setting(SETTING_HIDDEN_TAGS)
         tags = []
         if tag_names:
             tags = list(Tag.objects.filter(name__in=tag_names))
 
         return tags
 
     def add_hidden_tag(self, tag):
         tags = self.get_setting(SETTING_HIDDEN_TAGS)
         if not tags:
             tags = [tag.name]
         else:
             if not tag.name in tags:
                 tags.append(tag.name)
 
         tags.sort()
         self.set_setting(SETTING_HIDDEN_TAGS, tags)
 
     def del_hidden_tag(self, tag):
         tags = self.get_setting(SETTING_HIDDEN_TAGS)
         if tag.name in tags:
             tags.remove(tag.name)
             self.set_setting(SETTING_HIDDEN_TAGS, tags)
 
     def get_fav_threads(self) -> dict:
         return self.get_setting(SETTING_FAVORITE_THREADS, default=dict())
 
     def add_or_read_fav_thread(self, opening_post):
         threads = self.get_fav_threads()
 
         max_fav_threads = settings.get_int('View', 'MaxFavoriteThreads')
         if (str(opening_post.id) in threads) or (len(threads) < max_fav_threads):
             thread = opening_post.get_thread()
             # Don't check for new posts if the thread is archived already
             if thread.is_archived():
                 last_id = FAV_THREAD_NO_UPDATES
             else:
                 last_id = thread.get_replies().last().id
             threads[str(opening_post.id)] = last_id
             self.set_setting(SETTING_FAVORITE_THREADS, threads)
 
     def del_fav_thread(self, opening_post):
         threads = self.get_fav_threads()
         if self.thread_is_fav(opening_post):
             del threads[str(opening_post.id)]
             self.set_setting(SETTING_FAVORITE_THREADS, threads)
 
     def thread_is_fav(self, opening_post):
         return str(opening_post.id) in self.get_fav_threads()
 
     def get_notification_usernames(self):
         names = set()
         name_list = self.get_setting(SETTING_USERNAME)
         if name_list is not None:
             name_list = name_list.strip()
             if len(name_list) > 0:
                 names = name_list.lower().split(',')
                 names = set(name.strip() for name in names)
         return names
 
     def get_image_by_alias(self, alias):
         images = self.get_setting(SETTING_IMAGES)
         if images is not None and len(images) > 0:
             return images.get(alias)
 
     def add_image_alias(self, alias, image):
         images = self.get_setting(SETTING_IMAGES)
         if images is None:
             images = dict()
         images.put(alias, image)
 
 
 class SessionSettingsManager(SettingsManager):
     """
     Session-based settings manager. All settings are saved to the user's
     session.
     """
     def __init__(self, session):
         SettingsManager.__init__(self)
         self.session = session
 
     def get_setting(self, setting, default=None):
         if setting in self.session:
             return self.session[setting]
         else:
             self.set_setting(setting, default)
             return default
 
     def set_setting(self, setting, value):
         self.session[setting] = value
 
 
 def get_settings_manager(request) -> SettingsManager:
     """
     Get settings manager based on the request object. Currently only
     session-based manager is supported. In the future, cookie-based or
     database-based managers could be implemented.
     """
     return SessionSettingsManager(request.session)

boards/context_processors.py

@@ -1,88 +1,91 b''
 from boards.abstracts.settingsmanager import get_settings_manager, \
-    SETTING_LAST_NOTIFICATION_ID, SETTING_IMAGE_VIEWER
+    SETTING_LAST_NOTIFICATION_ID, SETTING_IMAGE_VIEWER, SETTING_ONLY_FAVORITES
 from boards.models.user import Notification
 from boards.models import Banner
 
 __author__ = 'neko259'
 
 import neboard
 from boards import settings
 from boards.models import Post, Tag, Thread
 
 CONTEXT_SITE_NAME = 'site_name'
 CONTEXT_VERSION = 'version'
 CONTEXT_THEME_CSS = 'theme_css'
 CONTEXT_THEME = 'theme'
 CONTEXT_PPD = 'posts_per_day'
 CONTEXT_USER = 'user'
 CONTEXT_NEW_NOTIFICATIONS_COUNT = 'new_notifications_count'
 CONTEXT_USERNAMES = 'usernames'
 CONTEXT_TAGS_STR = 'tags_str'
 CONTEXT_IMAGE_VIEWER = 'image_viewer'
 CONTEXT_HAS_FAV_THREADS = 'has_fav_threads'
 CONTEXT_POW_DIFFICULTY = 'pow_difficulty'
 CONTEXT_NEW_POST_COUNT = 'new_post_count'
 CONTEXT_SEARCH_ENABLED = 'search_enabled'
 CONTEXT_BANNERS = 'banners'
+CONTEXT_ONLY_FAVORITES = 'only_favorites'
 
 
 def get_notifications(context, settings_manager):
     usernames = settings_manager.get_notification_usernames()
     new_notifications_count = 0
     if usernames:
         last_notification_id = settings_manager.get_setting(
             SETTING_LAST_NOTIFICATION_ID)
 
         new_notifications_count = Notification.objects.get_notification_posts(
                 usernames=usernames, last=last_notification_id).only('id').count()
     context[CONTEXT_NEW_NOTIFICATIONS_COUNT] = new_notifications_count
     context[CONTEXT_USERNAMES] = usernames
 
 
 def get_new_post_count(context, settings_manager):
     fav_threads = settings_manager.get_fav_threads()
     if fav_threads:
         fav_thread_ops = Post.objects.filter(id__in=fav_threads.keys()) \
             .order_by('-pub_time').only('thread_id', 'pub_time')
         ops = [{'op': op, 'last_id': fav_threads[str(op.id)]} for op in fav_thread_ops]
         count = Thread.objects.get_new_post_count(ops)
         if count > 0:
             context[CONTEXT_NEW_POST_COUNT] = '(+{})'.format(count)
 
 
 def user_and_ui_processor(request):
     context = dict()
 
     context[CONTEXT_PPD] = float(Post.objects.get_posts_per_day())
 
     settings_manager = get_settings_manager(request)
     fav_tags = settings_manager.get_fav_tags()
 
     context[CONTEXT_TAGS_STR] = Tag.objects.get_tag_url_list(fav_tags)
     theme = settings_manager.get_theme()
     context[CONTEXT_THEME] = theme
 
     # TODO Use static here
     context[CONTEXT_THEME_CSS] = 'css/' + theme + '/base_page.css'
 
     context[CONTEXT_VERSION] = settings.get('Version', 'Version')
     context[CONTEXT_SITE_NAME] = settings.get('Version', 'SiteName')
 
     if (settings.get_bool('Forms', 'LimitFirstPosting') and not settings_manager.get_setting('confirmed_user'))\
             or settings.get_bool('Forms', 'LimitPostingSpeed'):
         context[CONTEXT_POW_DIFFICULTY] = settings.get_int('Forms', 'PowDifficulty')
 
     context[CONTEXT_IMAGE_VIEWER] = settings_manager.get_setting(
         SETTING_IMAGE_VIEWER,
         default=settings.get('View', 'DefaultImageViewer'))
 
     context[CONTEXT_HAS_FAV_THREADS] =\
         len(settings_manager.get_fav_threads()) > 0
 
     context[CONTEXT_SEARCH_ENABLED] = 'haystack' in neboard.settings.INSTALLED_APPS
     context[CONTEXT_BANNERS] = Banner.objects.order_by('-id')
+    context[CONTEXT_ONLY_FAVORITES] = settings_manager.get_setting(
+            SETTING_ONLY_FAVORITES, False)
 
     get_notifications(context, settings_manager)
     get_new_post_count(context, settings_manager)
 
     return context

boards/templates/boards/base.html

@@ -1,90 +1,96 b''
 {% load staticfiles %}
 {% load i18n %}
 {% load l10n %}
 {% load static from staticfiles %}
 
 <!DOCTYPE html>
 <html>
 <head>
     <link rel="stylesheet" type="text/css" href="{% static 'css/base.css' %}" media="all"/>
     <link rel="stylesheet" type="text/css" href="{% static 'css/3party/highlight.css' %}" media="all"/>
     <link rel="stylesheet" type="text/css" href="{% static 'css/3party/jquery-ui.min.css' %}" media="all"/>
     <link rel="stylesheet" type="text/css" href="{% static theme_css %}" media="all"/>
 
     {% if rss_url %}
         <link rel="alternate" type="application/rss+xml" href="{{ rss_url }}" title="{% trans 'Feed' %}"/>
     {% endif %}
 
     <link rel="icon" type="image/png"
         href="{% static 'favicon.png' %}">
 
     <meta name="viewport" content="width=device-width, initial-scale=1"/>
     <meta charset="utf-8"/>
 
     {% block head %}{% endblock %}
 </head>
 <body data-image-viewer="{{ image_viewer }}"
       data-pow-difficulty="{{ pow_difficulty }}"
       data-update-script="{% static 'js/updates.js' %}">
     <script src="{% static 'js/jquery-2.2.0.min.js' %}"></script>
 
     <header class="navigation_panel">
         <a class="link" href="{% url 'index' %}">{% trans "All threads" %}</a>
         {% if tags_str %}
-            <a href="{% url 'index' %}?filter=fav_tags" title="{% trans "interesting" %}">★</a>,
+            <form action="{% url 'index' %}" method="post" class="post-button-form">{% csrf_token %}
+            {% if only_favorites %}
+                <button name="method" value="toggle_fav" class="fav">★</button>,
+            {% else %}
+                <button name="method" value="toggle_fav" class="not_fav">★</button>,
+            {% endif %}
+            </form>
             {{ tags_str|safe }},
         {% else %}
             {% trans 'Add tags' %} → 
         {% endif %}
         <a href="{% url 'tags' 'required'%}" title="{% trans 'Tag management' %}">{% trans "tags" %}</a>,
         {% if search_enabled %}
             <a href="{% url 'search' %}" title="{% trans 'Search' %}">{% trans 'search' %}</a>,
         {% endif %}
         <a href="{% url 'feed' %}" title="{% trans 'Feed' %}">{% trans 'feed' %}</a>,
         <a href="{% url 'random' %}" title="{% trans 'Random images' %}">{% trans 'images' %}</a>{% if has_fav_threads %},
 
         <a href="{% url 'feed' %}?favorites" id="fav-panel-btn">{% trans 'favorites' %} <span id="new-fav-post-count" {% if not new_post_count %}style="display: none" {% endif %}>{{ new_post_count }}</span></a>
         {% endif %}
 
         {% if usernames %}
             <a class="right-link link" href="{% url 'notifications' %}" title="{% trans 'Notifications' %}">
                 {% trans 'Notifications' %}
                 {% ifnotequal new_notifications_count 0 %}
                     (<b>{{ new_notifications_count }}</b>)
                 {% endifnotequal %}
             </a>
         {% endif %}
 
         <a class="right-link link" href="{% url 'settings' %}">{% trans 'Settings' %}</a>
     </header>
 
     <div id="fav-panel"><div class="post">{% trans "Loading..." %}</div></div>
 
     {% block content %}{% endblock %}
 
     <script src="{% static 'js/3party/jquery-ui.min.js' %}"></script>
     <script src="{% static 'js/jquery.mousewheel.js' %}"></script>
     <script src="{% static 'js/3party/highlight.min.js' %}"></script>
 
     <script src="{% url 'js_info_dict' %}"></script>
 
     <script src="{% static 'js/popup.js' %}"></script>
     <script src="{% static 'js/image.js' %}"></script>
     <script src="{% static 'js/refpopup.js' %}"></script>
     <script src="{% static 'js/main.js' %}"></script>
 
     <footer class="navigation_panel">
         {% block metapanel %}{% endblock %}
         {% if rss_url %}
             [<a href="{{ rss_url }}">RSS</a>]
         {% endif %}
         [<a href="{% url 'admin:index' %}">{% trans 'Admin' %}</a>]
         [<a href="{% url 'index' %}?order=pub">{% trans 'New threads' %}</a>]
         {% with ppd=posts_per_day|floatformat:2 %}
             {% blocktrans %}Speed: {{ ppd }} posts per day{% endblocktrans %}
         {% endwith %}
         <a class="link" href="#top" id="up">{% trans 'Up' %}</a>
     </footer>
 
 </body>
 </html>

boards/views/all_threads.py

@@ -1,172 +1,184 b''
 from django.core.urlresolvers import reverse
 from django.core.files import File
 from django.core.files.temp import NamedTemporaryFile
 from django.core.paginator import EmptyPage
 from django.db import transaction
 from django.http import Http404
 from django.shortcuts import render, redirect
 from django.utils.decorators import method_decorator
 from django.views.decorators.csrf import csrf_protect
 
 from boards import utils, settings
 from boards.abstracts.paginator import get_paginator
-from boards.abstracts.settingsmanager import get_settings_manager
+from boards.abstracts.settingsmanager import get_settings_manager,\
+        SETTING_ONLY_FAVORITES
 from boards.forms import ThreadForm, PlainErrorList
 from boards.models import Post, Thread, Ban
 from boards.views.banned import BannedView
 from boards.views.base import BaseBoardView, CONTEXT_FORM
 from boards.views.posting_mixin import PostMixin
-from boards.views.mixins import FileUploadMixin, PaginatedMixin
+from boards.views.mixins import FileUploadMixin, PaginatedMixin,\
+        DispatcherMixin, PARAMETER_METHOD
 
 FORM_TAGS = 'tags'
 FORM_TEXT = 'text'
 FORM_TITLE = 'title'
 FORM_IMAGE = 'image'
 FORM_THREADS = 'threads'
 
 TAG_DELIMITER = ' '
 
 PARAMETER_CURRENT_PAGE = 'current_page'
 PARAMETER_PAGINATOR = 'paginator'
 PARAMETER_THREADS = 'threads'
 PARAMETER_ADDITIONAL = 'additional_params'
 PARAMETER_MAX_FILE_SIZE = 'max_file_size'
 PARAMETER_RSS_URL = 'rss_url'
 
 TEMPLATE = 'boards/all_threads.html'
 DEFAULT_PAGE = 1
 
 
-class AllThreadsView(PostMixin, FileUploadMixin, BaseBoardView, PaginatedMixin):
+class AllThreadsView(PostMixin, FileUploadMixin, BaseBoardView, PaginatedMixin, DispatcherMixin):
 
     def __init__(self):
         self.settings_manager = None
         super(AllThreadsView, self).__init__()
 
     @method_decorator(csrf_protect)
     def get(self, request, form: ThreadForm=None):
         page = request.GET.get('page', DEFAULT_PAGE)
 
         params = self.get_context_data(request=request)
 
         if not form:
             form = ThreadForm(error_class=PlainErrorList)
 
         self.settings_manager = get_settings_manager(request)
 
         threads = self.get_threads()
 
         order = request.GET.get('order', 'bump')
         if order == 'bump':
             threads = threads.order_by('-bump_time')
         else:
             threads = threads.filter(multi_replies__opening=True).order_by('-multi_replies__pub_time')
         filter = request.GET.get('filter')
-        if filter == 'fav_tags':
+        if self.settings_manager.get_setting(SETTING_ONLY_FAVORITES):
             fav_tags = self.settings_manager.get_fav_tags()
             if len(fav_tags) > 0:
                 threads = threads.filter(tags__in=fav_tags)
         threads = threads.distinct()
 
         paginator = get_paginator(threads,
                                   settings.get_int('View', 'ThreadsPerPage'))
         paginator.current_page = int(page)
 
         try:
             threads = paginator.page(page).object_list
         except EmptyPage:
             raise Http404()
 
         params[PARAMETER_THREADS] = threads
         params[CONTEXT_FORM] = form
         params[PARAMETER_MAX_FILE_SIZE] = self.get_max_upload_size()
         params[PARAMETER_RSS_URL] = self.get_rss_url()
 
         paginator.set_url(self.get_reverse_url(), request.GET.dict())
         self.get_page_context(paginator, params, page)
 
         return render(request, TEMPLATE, params)
 
     @method_decorator(csrf_protect)
     def post(self, request):
+        if PARAMETER_METHOD in request.POST:
+            self.dispatch_method(request)
+
+            return redirect('index')  # FIXME Different for different modes
+
         form = ThreadForm(request.POST, request.FILES,
                           error_class=PlainErrorList)
         form.session = request.session
 
         if form.is_valid():
             return self.create_thread(request, form)
         if form.need_to_ban:
             # Ban user because he is suspected to be a bot
             self._ban_current_user(request)
 
         return self.get(request, form)
 
     def get_page_context(self, paginator, params, page):
         """
         Get pagination context variables
         """
 
         params[PARAMETER_PAGINATOR] = paginator
         current_page = paginator.page(int(page))
         params[PARAMETER_CURRENT_PAGE] = current_page
         self.set_page_urls(paginator, params)
 
     def get_reverse_url(self):
         return reverse('index')
 
     @transaction.atomic
     def create_thread(self, request, form: ThreadForm, html_response=True):
         """
         Creates a new thread with an opening post.
         """
 
         ip = utils.get_client_ip(request)
         is_banned = Ban.objects.filter(ip=ip).exists()
 
         if is_banned:
             if html_response:
                 return redirect(BannedView().as_view())
             else:
                 return
 
         data = form.cleaned_data
 
         title = form.get_title()
         text = data[FORM_TEXT]
         file = form.get_file()
         file_url = form.get_file_url()
         threads = data[FORM_THREADS]
         images = form.get_images()
 
         text = self._remove_invalid_links(text)
 
         tags = data[FORM_TAGS]
         monochrome = form.is_monochrome()
 
         post = Post.objects.create_post(title=title, text=text, file=file,
                                         ip=ip, tags=tags, opening_posts=threads,
                                         tripcode=form.get_tripcode(),
                                         monochrome=monochrome, images=images,
                                         file_url = file_url)
 
         # This is required to update the threads to which posts we have replied
         # when creating this one
         post.notify_clients()
 
         if form.is_subscribe():
             settings_manager = get_settings_manager(request)
             settings_manager.add_or_read_fav_thread(post)
 
         if html_response:
             return redirect(post.get_absolute_url())
 
     def get_threads(self):
         """
         Gets list of threads that will be shown on a page.
         """
 
         return Thread.objects\
             .exclude(tags__in=self.settings_manager.get_hidden_tags())
 
     def get_rss_url(self):
         return self.get_reverse_url() + 'rss/'
+
+    def toggle_fav(self, request):
+        settings_manager = get_settings_manager(request)
+        settings_manager.set_setting(SETTING_ONLY_FAVORITES,
+                not settings_manager.get_setting(SETTING_ONLY_FAVORITES, False))