Added support for different attachment types

boards/migrations/0022_auto_20150812_1819.py

@@ -0,0 +1,19 b''
+# -*- coding: utf-8 -*-
+from __future__ import unicode_literals
+
+from django.db import models, migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('boards', '0021_tag_description'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='thread',
+            name='tags',
+            field=models.ManyToManyField(related_name='thread_tags', to='boards.Tag'),
+        ),
+    ]

boards/migrations/0023_auto_20150818_1026.py

@@ -0,0 +1,29 b''
+# -*- coding: utf-8 -*-
+from __future__ import unicode_literals
+
+from django.db import models, migrations
+import boards.models.attachment
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('boards', '0022_auto_20150812_1819'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Attachment',
+            fields=[
+                ('id', models.AutoField(verbose_name='ID', primary_key=True, serialize=False, auto_created=True)),
+                ('file', models.FileField(upload_to=boards.models.attachment.Attachment._update_filename)),
+                ('mimetype', models.CharField(max_length=50)),
+                ('hash', models.CharField(max_length=36)),
+            ],
+        ),
+        migrations.AddField(
+            model_name='post',
+            name='attachments',
+            field=models.ManyToManyField(blank=True, null=True, related_name='attachment_posts', to='boards.Attachment'),
+        ),
+    ]

boards/models/attachment/__init__.py

@@ -0,0 +1,75 b''
+import hashlib
+import os
+import time
+
+from random import random
+
+from django.db import models
+
+from boards.models.attachment.viewers import AbstractViewer, WebmViewer
+
+
+FILES_DIRECTORY = 'files/'
+FILE_EXTENSION_DELIMITER = '.'
+
+VIEWERS = (
+    WebmViewer,
+)
+
+
+class AttachmentManager(models.Manager):
+    def create_with_hash(self, file):
+        file_hash = self.get_hash(file)
+        existing = self.filter(hash=file_hash)
+        if len(existing) > 0:
+            attachment = existing[0]
+        else:
+            file_type = file.name.split(FILE_EXTENSION_DELIMITER)[-1].lower()
+            attachment = Attachment.objects.create(file=file,
+                    mimetype=file_type, hash=file_hash)
+
+        return attachment
+
+    def get_hash(self, file):
+        """
+        Gets hash of an file.
+        """
+        md5 = hashlib.md5()
+        for chunk in file.chunks():
+            md5.update(chunk)
+        return md5.hexdigest()
+
+
+class Attachment(models.Model):
+    objects = AttachmentManager()
+
+    # TODO Dedup the method
+    def _update_filename(self, filename):
+        """
+        Gets unique filename
+        """
+
+        # TODO Use something other than random number in file name
+        new_name = '{}{}.{}'.format(
+            str(int(time.mktime(time.gmtime()))),
+            str(int(random() * 1000)),
+            filename.split(FILE_EXTENSION_DELIMITER)[-1:][0])
+
+        return os.path.join(FILES_DIRECTORY, new_name)
+
+    file = models.FileField(upload_to=_update_filename)
+    mimetype = models.CharField(max_length=50)
+    hash = models.CharField(max_length=36)
+
+    def get_view(self):
+        file_viewer = None
+        for viewer in VIEWERS:
+            if viewer.supports(self.mimetype):
+                file_viewer = viewer(self.file, self.mimetype)
+                break
+        if file_viewer is None:
+            file_viewer = AbstractViewer(self.file, self.mimetype)
+
+        return file_viewer.get_view()
+
+

boards/models/attachment/viewers.py

@@ -0,0 +1,39 b''
+from django.template.defaultfilters import filesizeformat
+
+
+class AbstractViewer:
+    def __init__(self, file, file_type):
+        self.file = file
+        self.file_type = file_type
+
+    @staticmethod
+    def get_viewer(file_type, file):
+        for viewer in VIEWERS:
+            if viewer.supports(file_type):
+                return viewer(file)
+        return AbstractViewer(file)
+
+    @staticmethod
+    def supports(file_type):
+        return true
+
+    def get_view(self):
+        return '<div class="image"><a href="{}">'\
+               '<img src="/static/images/file.png" width="200" height="150"/>'\
+               '</a>'\
+               '<div class="image-metadata">{}, {}</div>'\
+               '</div>'.format(self.file.url, self.file_type,
+                       filesizeformat(self.file.size))
+
+
+class WebmViewer(AbstractViewer):
+    @staticmethod
+    def supports(file_type):
+        return file_type == 'webm'
+
+    def get_view(self):
+        return '<div class="image">'\
+               '<video width="200" height="150" controls/>'\
+               '<source src="{}">'\
+               '</div>'.format(self.file.url)
+

boards/config/default_settings.ini

@@ -1,33 +1,33 b''
 [Version]
 Version = 2.8.3 Charlie
 SiteName = Neboard DEV
 
 [Cache]
 # Timeout for caching, if cache is used
 CacheTimeout = 600
 
 [Forms]
 # Max post length in characters
 MaxTextLength = 30000
-MaxImageSize = 8000000
+MaxFileSize = 8000000
 LimitPostingSpeed = false
 
 [Messages]
 # Thread bumplimit
 MaxPostsPerThread = 10
 # Old posts will be archived or deleted if this value is reached
 MaxThreadCount = 5
 
 [View]
 DefaultTheme = md
 DefaultImageViewer = simple
 LastRepliesCount = 3
 ThreadsPerPage = 3
 
 [Storage]
 # Enable archiving threads instead of deletion when the thread limit is reached
 ArchiveThreads = true
 
 [External]
 # Thread update
 WebsocketsEnabled = false

boards/forms.py

@@ -1,386 +1,377 b''
 import re
 import time
 import pytz
 
 from django import forms
 from django.core.files.uploadedfile import SimpleUploadedFile
 from django.core.exceptions import ObjectDoesNotExist
 from django.forms.util import ErrorList
 from django.utils.translation import ugettext_lazy as _
 import requests
 
 from boards.mdx_neboard import formatters
 from boards.models.post import TITLE_MAX_LENGTH
 from boards.models import Tag, Post
 from neboard import settings
 import boards.settings as board_settings
 
 HEADER_CONTENT_LENGTH = 'content-length'
 HEADER_CONTENT_TYPE = 'content-type'
 
-CONTENT_TYPE_IMAGE = (
-    'image/jpeg',
-    'image/jpg',
-    'image/png',
-    'image/gif',
-    'image/bmp',
-)
-
 REGEX_TAGS = re.compile(r'^[\w\s\d]+$', re.UNICODE)
 
 VETERAN_POSTING_DELAY = 5
 
 ATTRIBUTE_PLACEHOLDER = 'placeholder'
 ATTRIBUTE_ROWS = 'rows'
 
 LAST_POST_TIME = 'last_post_time'
 LAST_LOGIN_TIME = 'last_login_time'
 TEXT_PLACEHOLDER = _('Type message here. Use formatting panel for more advanced usage.')
 TAGS_PLACEHOLDER = _('music images i_dont_like_tags')
 
 LABEL_TITLE = _('Title')
 LABEL_TEXT = _('Text')
 LABEL_TAG = _('Tag')
 LABEL_SEARCH = _('Search')
 
 ERROR_SPEED = _('Please wait %s seconds before sending message')
 
 TAG_MAX_LENGTH = 20
 
-IMAGE_DOWNLOAD_CHUNK_BYTES = 100000
+FILE_DOWNLOAD_CHUNK_BYTES = 100000
 
 HTTP_RESULT_OK = 200
 
 TEXTAREA_ROWS = 4
 
 
 def get_timezones():
     timezones = []
     for tz in pytz.common_timezones:
         timezones.append((tz, tz),)
     return timezones
 
 
 class FormatPanel(forms.Textarea):
     """
     Panel for text formatting. Consists of buttons to add different tags to the
     form text area.
     """
 
     def render(self, name, value, attrs=None):
         output = '<div id="mark-panel">'
         for formatter in formatters:
             output += '<span class="mark_btn"' + \
                       ' onClick="addMarkToMsg(\'' + formatter.format_left + \
                       '\', \'' + formatter.format_right + '\')">' + \
                       formatter.preview_left + formatter.name + \
                       formatter.preview_right + '</span>'
 
         output += '</div>'
         output += super(FormatPanel, self).render(name, value, attrs=None)
 
         return output
 
 
 class PlainErrorList(ErrorList):
     def __unicode__(self):
         return self.as_text()
 
     def as_text(self):
         return ''.join(['(!) %s ' % e for e in self])
 
 
 class NeboardForm(forms.Form):
     """
     Form with neboard-specific formatting.
     """
 
     def as_div(self):
         """
         Returns this form rendered as HTML <as_div>s.
         """
 
         return self._html_output(
             # TODO Do not show hidden rows in the list here
             normal_row='<div class="form-row">'
                        '<div class="form-label">'
                        '%(label)s'
                        '</div>'
                        '<div class="form-input">'
                        '%(field)s'
                        '</div>'
                        '</div>'
                        '<div class="form-row">'
                        '%(help_text)s'
                        '</div>',
             error_row='<div class="form-row">'
                       '<div class="form-label"></div>'
                       '<div class="form-errors">%s</div>'
                       '</div>',
             row_ender='</div>',
             help_text_html='%s',
             errors_on_separate_row=True)
 
     def as_json_errors(self):
         errors = []
 
         for name, field in list(self.fields.items()):
             if self[name].errors:
                 errors.append({
                     'field': name,
                     'errors': self[name].errors.as_text(),
                 })
 
         return errors
 
 
 class PostForm(NeboardForm):
 
     title = forms.CharField(max_length=TITLE_MAX_LENGTH, required=False,
                             label=LABEL_TITLE)
     text = forms.CharField(
         widget=FormatPanel(attrs={
             ATTRIBUTE_PLACEHOLDER: TEXT_PLACEHOLDER,
             ATTRIBUTE_ROWS: TEXTAREA_ROWS,
         }),
         required=False, label=LABEL_TEXT)
-    image = forms.ImageField(required=False, label=_('Image'),
+    file = forms.FileField(required=False, label=_('File'),
                              widget=forms.ClearableFileInput(
-                                 attrs={'accept': 'image/*'}))
-    image_url = forms.CharField(required=False, label=_('Image URL'),
+                                 attrs={'accept': 'file/*'}))
+    file_url = forms.CharField(required=False, label=_('File URL'),
                                 widget=forms.TextInput(
                                     attrs={ATTRIBUTE_PLACEHOLDER:
                                                'http://example.com/image.png'}))
 
     # This field is for spam prevention only
     email = forms.CharField(max_length=100, required=False, label=_('e-mail'),
                             widget=forms.TextInput(attrs={
                                 'class': 'form-email'}))
     threads = forms.CharField(required=False, label=_('Additional threads'),
             widget=forms.TextInput(attrs={ATTRIBUTE_PLACEHOLDER:
                 '123 456 789'}))
 
     session = None
     need_to_ban = False
 
     def clean_title(self):
         title = self.cleaned_data['title']
         if title:
             if len(title) > TITLE_MAX_LENGTH:
                 raise forms.ValidationError(_('Title must have less than %s '
                                               'characters') %
                                             str(TITLE_MAX_LENGTH))
         return title
 
     def clean_text(self):
         text = self.cleaned_data['text'].strip()
         if text:
             max_length = board_settings.get_int('Forms', 'MaxTextLength')
             if len(text) > max_length:
                 raise forms.ValidationError(_('Text must have less than %s '
                                               'characters') % str(max_length))
         return text
 
-    def clean_image(self):
-        image = self.cleaned_data['image']
+    def clean_file(self):
+        file = self.cleaned_data['file']
 
-        if image:
-            self.validate_image_size(image.size)
+        if file:
+            self.validate_file_size(file.size)
 
-        return image
+        return file
 
-    def clean_image_url(self):
-        url = self.cleaned_data['image_url']
+    def clean_file_url(self):
+        url = self.cleaned_data['file_url']
 
-        image = None
+        file = None
         if url:
-            image = self._get_image_from_url(url)
+            file = self._get_file_from_url(url)
 
-            if not image:
+            if not file:
                 raise forms.ValidationError(_('Invalid URL'))
             else:
-                self.validate_image_size(image.size)
+                self.validate_file_size(file.size)
 
-        return image
+        return file
 
     def clean_threads(self):
         threads_str = self.cleaned_data['threads']
 
         if len(threads_str) > 0:
             threads_id_list = threads_str.split(' ')
 
             threads = list()
 
             for thread_id in threads_id_list:
                 try:
                     thread = Post.objects.get(id=int(thread_id))
                     if not thread.is_opening() or thread.get_thread().archived:
                         raise ObjectDoesNotExist()
                     threads.append(thread)
                 except (ObjectDoesNotExist, ValueError):
                     raise forms.ValidationError(_('Invalid additional thread list'))
 
             return threads
 
     def clean(self):
         cleaned_data = super(PostForm, self).clean()
 
         if cleaned_data['email']:
             self.need_to_ban = True
             raise forms.ValidationError('A human cannot enter a hidden field')
 
         if not self.errors:
-            self._clean_text_image()
+            self._clean_text_file()
 
         if not self.errors and self.session:
             self._validate_posting_speed()
 
         return cleaned_data
 
-    def get_image(self):
+    def get_file(self):
         """
-        Gets image from file or URL.
+        Gets file from form or URL.
         """
 
-        image = self.cleaned_data['image']
-        return image if image else self.cleaned_data['image_url']
+        file = self.cleaned_data['file']
+        return file or self.cleaned_data['file_url']
 
-    def _clean_text_image(self):
+    def _clean_text_file(self):
         text = self.cleaned_data.get('text')
-        image = self.get_image()
+        file = self.get_file()
 
-        if (not text) and (not image):
-            error_message = _('Either text or image must be entered.')
+        if (not text) and (not file):
+            error_message = _('Either text or file must be entered.')
             self._errors['text'] = self.error_class([error_message])
 
     def _validate_posting_speed(self):
         can_post = True
 
         posting_delay = settings.POSTING_DELAY
 
         if board_settings.get_bool('Forms', 'LimitPostingSpeed'):
             now = time.time()
 
             current_delay = 0
             need_delay = False
 
             if not LAST_POST_TIME in self.session:
                 self.session[LAST_POST_TIME] = now
 
                 need_delay = True
             else:
                 last_post_time = self.session.get(LAST_POST_TIME)
                 current_delay = int(now - last_post_time)
 
                 need_delay = current_delay < posting_delay
 
             if need_delay:
                 error_message = ERROR_SPEED % str(posting_delay
                         - current_delay)
                 self._errors['text'] = self.error_class([error_message])
 
                 can_post = False
 
             if can_post:
                 self.session[LAST_POST_TIME] = now
 
-    def validate_image_size(self, size: int):
-        max_size = board_settings.get_int('Forms', 'MaxImageSize')
+    def validate_file_size(self, size: int):
+        max_size = board_settings.get_int('Forms', 'MaxFileSize')
         if size > max_size:
             raise forms.ValidationError(
-                _('Image must be less than %s bytes')
+                _('File must be less than %s bytes')
                 % str(max_size))
 
-    def _get_image_from_url(self, url: str) -> SimpleUploadedFile:
+    def _get_file_from_url(self, url: str) -> SimpleUploadedFile:
         """
-        Gets an image file from URL.
+        Gets an file file from URL.
         """
 
         img_temp = None
 
         try:
             # Verify content headers
             response_head = requests.head(url, verify=False)
             content_type = response_head.headers[HEADER_CONTENT_TYPE].split(';')[0]
-            if content_type in CONTENT_TYPE_IMAGE:
-                length_header = response_head.headers.get(HEADER_CONTENT_LENGTH)
-                if length_header:
-                    length = int(length_header)
-                    self.validate_image_size(length)
-                # Get the actual content into memory
-                response = requests.get(url, verify=False, stream=True)
+            length_header = response_head.headers.get(HEADER_CONTENT_LENGTH)
+            if length_header:
+                length = int(length_header)
+                self.validate_file_size(length)
+            # Get the actual content into memory
+            response = requests.get(url, verify=False, stream=True)
 
-                # Download image, stop if the size exceeds limit
-                size = 0
-                content = b''
-                for chunk in response.iter_content(IMAGE_DOWNLOAD_CHUNK_BYTES):
-                    size += len(chunk)
-                    self.validate_image_size(size)
-                    content += chunk
+            # Download file, stop if the size exceeds limit
+            size = 0
+            content = b''
+            for chunk in response.iter_content(file_DOWNLOAD_CHUNK_BYTES):
+                size += len(chunk)
+                self.validate_file_size(size)
+                content += chunk
 
-                if response.status_code == HTTP_RESULT_OK and content:
-                    # Set a dummy file name that will be replaced
-                    # anyway, just keep the valid extension
-                    filename = 'image.' + content_type.split('/')[1]
-                    img_temp = SimpleUploadedFile(filename, content,
-                                                  content_type)
+            if response.status_code == HTTP_RESULT_OK and content:
+                # Set a dummy file name that will be replaced
+                # anyway, just keep the valid extension
+                filename = 'file.' + content_type.split('/')[1]
+                img_temp = SimpleUploadedFile(filename, content,
+                                              content_type)
         except Exception:
-            # Just return no image
+            # Just return no file
             pass
 
         return img_temp
 
 
 class ThreadForm(PostForm):
 
     tags = forms.CharField(
         widget=forms.TextInput(attrs={ATTRIBUTE_PLACEHOLDER: TAGS_PLACEHOLDER}),
         max_length=100, label=_('Tags'), required=True)
 
     def clean_tags(self):
         tags = self.cleaned_data['tags'].strip()
 
         if not tags or not REGEX_TAGS.match(tags):
             raise forms.ValidationError(
                 _('Inappropriate characters in tags.'))
 
         required_tag_exists = False
         for tag in tags.split():
             try:
                 Tag.objects.get(name=tag.strip().lower(), required=True)
                 required_tag_exists = True
                 break
             except ObjectDoesNotExist:
                 pass
 
         if not required_tag_exists:
             all_tags = Tag.objects.filter(required=True)
             raise forms.ValidationError(
                 _('Need at least one section.'))
 
         return tags
 
     def clean(self):
         cleaned_data = super(ThreadForm, self).clean()
 
         return cleaned_data
 
 
 class SettingsForm(NeboardForm):
 
     theme = forms.ChoiceField(choices=settings.THEMES, label=_('Theme'))
-    image_viewer = forms.ChoiceField(choices=settings.IMAGE_VIEWERS, label=_('Image view mode'))
+    image_viewer = forms.ChoiceField(choices=settings.IMAGE_VIEWERS, label=_('image view mode'))
     username = forms.CharField(label=_('User name'), required=False)
     timezone = forms.ChoiceField(choices=get_timezones(), label=_('Time zone'))
 
     def clean_username(self):
         username = self.cleaned_data['username']
 
         if username and not REGEX_TAGS.match(username):
             raise forms.ValidationError(_('Inappropriate characters.'))
 
         return username
 
 
 class SearchForm(NeboardForm):
     query = forms.CharField(max_length=500, label=LABEL_SEARCH, required=False)

boards/models/__init__.py

@@ -1,8 +1,9 b''
 __author__ = 'neko259'
 
 from boards.models.image import PostImage
+from boards.models.attachment import Attachment
 from boards.models.thread import Thread
 from boards.models.post import Post
 from boards.models.tag import Tag
 from boards.models.user import Ban
 from boards.models.banner import Banner

boards/models/image.py

@@ -1,123 +1,121 b''
 import hashlib
 import os
 from random import random
 import time
 
 from django.db import models
 from django.template.defaultfilters import filesizeformat
 
 from boards import thumbs
 import boards
 from boards.models.base import Viewable
 
 __author__ = 'neko259'
 
 
 IMAGE_THUMB_SIZE = (200, 150)
 IMAGES_DIRECTORY = 'images/'
 FILE_EXTENSION_DELIMITER = '.'
 HASH_LENGTH = 36
 
 CSS_CLASS_IMAGE = 'image'
 CSS_CLASS_THUMB = 'thumb'
 
 
 class PostImageManager(models.Manager):
     def create_with_hash(self, image):
         image_hash = self.get_hash(image)
         existing = self.filter(hash=image_hash)
         if len(existing) > 0:
             post_image = existing[0]
         else:
             post_image = PostImage.objects.create(image=image)
 
         return post_image
 
     def get_hash(self, image):
         """
         Gets hash of an image.
         """
         md5 = hashlib.md5()
         for chunk in image.chunks():
             md5.update(chunk)
         return md5.hexdigest()
 
     def get_random_images(self, count, include_archived=False, tags=None):
         images = self.filter(post_images__thread__archived=include_archived)
         if tags is not None:
             images = images.filter(post_images__threads__tags__in=tags)
         return images.order_by('?')[:count]
 
 
 class PostImage(models.Model, Viewable):
     objects = PostImageManager()
 
     class Meta:
         app_label = 'boards'
         ordering = ('id',)
 
     def _update_image_filename(self, filename):
         """
         Gets unique image filename
         """
 
-        path = IMAGES_DIRECTORY
-
         # TODO Use something other than random number in file name
         new_name = '{}{}.{}'.format(
             str(int(time.mktime(time.gmtime()))),
             str(int(random() * 1000)),
             filename.split(FILE_EXTENSION_DELIMITER)[-1:][0])
 
-        return os.path.join(path, new_name)
+        return os.path.join(IMAGES_DIRECTORY, new_name)
 
     width = models.IntegerField(default=0)
     height = models.IntegerField(default=0)
 
     pre_width = models.IntegerField(default=0)
     pre_height = models.IntegerField(default=0)
 
     image = thumbs.ImageWithThumbsField(upload_to=_update_image_filename,
                                         blank=True, sizes=(IMAGE_THUMB_SIZE,),
                                         width_field='width',
                                         height_field='height',
                                         preview_width_field='pre_width',
                                         preview_height_field='pre_height')
     hash = models.CharField(max_length=HASH_LENGTH)
 
     def save(self, *args, **kwargs):
         """
         Saves the model and computes the image hash for deduplication purposes.
         """
 
         if not self.pk and self.image:
             self.hash = PostImage.objects.get_hash(self.image)
         super(PostImage, self).save(*args, **kwargs)
 
     def __str__(self):
         return self.image.url
 
     def get_view(self):
         metadata = '{}, {}'.format(self.image.name.split('.')[-1],
                                    filesizeformat(self.image.size))
         return '<div class="{}">' \
                '<a class="{}" href="{full}">' \
                '<img class="post-image-preview"' \
                ' src="{}"' \
                ' alt="{}"' \
                ' width="{}"' \
                ' height="{}"' \
                ' data-width="{}"' \
                ' data-height="{}" />' \
                '</a>' \
                '<div class="image-metadata">{image_meta}</div>' \
                '</div>'\
             .format(CSS_CLASS_IMAGE, CSS_CLASS_THUMB,
                     self.image.url_200x150,
                     str(self.hash), str(self.pre_width),
                     str(self.pre_height), str(self.width), str(self.height),
                     full=self.image.url, image_meta=metadata)
 
     def get_random_associated_post(self):
         posts = boards.models.Post.objects.filter(images__in=[self])
         return posts.order_by('?').first()

boards/models/post/__init__.py

@@ -1,418 +1,432 b''
 from datetime import datetime, timedelta, date
 from datetime import time as dtime
 import logging
 import re
 import uuid
 
 from django.core.exceptions import ObjectDoesNotExist
 from django.core.urlresolvers import reverse
 from django.db import models, transaction
 from django.db.models import TextField, QuerySet
 from django.template.loader import render_to_string
 from django.utils import timezone
 
 from boards import settings
 from boards.mdx_neboard import Parser
-from boards.models import PostImage
+from boards.models import PostImage, Attachment
 from boards.models.base import Viewable
 from boards import utils
 from boards.models.post.export import get_exporter, DIFF_TYPE_JSON
 from boards.models.user import Notification, Ban
 import boards.models.thread
 
 
 APP_LABEL_BOARDS = 'boards'
 
 POSTS_PER_DAY_RANGE = 7
 
 BAN_REASON_AUTO = 'Auto'
 
 IMAGE_THUMB_SIZE = (200, 150)
 
 TITLE_MAX_LENGTH = 200
 
 # TODO This should be removed
 NO_IP = '0.0.0.0'
 
 REGEX_REPLY = re.compile(r'\[post\](\d+)\[/post\]')
 REGEX_NOTIFICATION = re.compile(r'\[user\](\w+)\[/user\]')
 
 PARAMETER_TRUNCATED = 'truncated'
 PARAMETER_TAG = 'tag'
 PARAMETER_OFFSET = 'offset'
 PARAMETER_DIFF_TYPE = 'type'
 PARAMETER_CSS_CLASS = 'css_class'
 PARAMETER_THREAD = 'thread'
 PARAMETER_IS_OPENING = 'is_opening'
 PARAMETER_MODERATOR = 'moderator'
 PARAMETER_POST = 'post'
 PARAMETER_OP_ID = 'opening_post_id'
 PARAMETER_NEED_OPEN_LINK = 'need_open_link'
 PARAMETER_REPLY_LINK = 'reply_link'
 PARAMETER_NEED_OP_DATA = 'need_op_data'
 
 POST_VIEW_PARAMS = (
     'need_op_data',
     'reply_link',
     'moderator',
     'need_open_link',
     'truncated',
     'mode_tree',
 )
 
 REFMAP_STR = '<a href="{}">&gt;&gt;{}</a>'
 
+IMAGE_TYPES = (
+    'jpeg',
+    'jpg',
+    'png',
+    'bmp',
+)
+
 
 class PostManager(models.Manager):
     @transaction.atomic
-    def create_post(self, title: str, text: str, image=None, thread=None,
+    def create_post(self, title: str, text: str, file=None, thread=None,
             ip=NO_IP, tags: list=None, opening_posts: list=None):
         """
         Creates new post
         """
 
         is_banned = Ban.objects.filter(ip=ip).exists()
 
         # TODO Raise specific exception and catch it in the views
         if is_banned:
             raise Exception("This user is banned")
 
         if not tags:
             tags = []
         if not opening_posts:
             opening_posts = []
 
         posting_time = timezone.now()
         new_thread = False
         if not thread:
             thread = boards.models.thread.Thread.objects.create(
                 bump_time=posting_time, last_edit_time=posting_time)
             list(map(thread.tags.add, tags))
             boards.models.thread.Thread.objects.process_oldest_threads()
             new_thread = True
 
         pre_text = Parser().preparse(text)
 
         post = self.create(title=title,
                            text=pre_text,
                            pub_time=posting_time,
                            poster_ip=ip,
                            thread=thread,
                            last_edit_time=posting_time)
         post.threads.add(thread)
 
         logger = logging.getLogger('boards.post.create')
 
         logger.info('Created post {} by {}'.format(post, post.poster_ip))
 
-        if image:
-            post.images.add(PostImage.objects.create_with_hash(image))
+        # TODO Move this to other place
+        if file:
+            file_type = file.name.split('.')[-1].lower()
+            if file_type in IMAGE_TYPES:
+                post.images.add(PostImage.objects.create_with_hash(file))
+            else:
+                post.attachments.add(Attachment.objects.create_with_hash(file))
 
         post.build_url()
         post.connect_replies()
         post.connect_threads(opening_posts)
         post.connect_notifications()
 
         # Thread needs to be bumped only when the post is already created
         if not new_thread:
             thread.last_edit_time = posting_time
             thread.bump()
             thread.save()
 
         return post
 
     def delete_posts_by_ip(self, ip):
         """
         Deletes all posts of the author with same IP
         """
 
         posts = self.filter(poster_ip=ip)
         for post in posts:
             post.delete()
 
     @utils.cached_result()
     def get_posts_per_day(self) -> float:
         """
         Gets average count of posts per day for the last 7 days
         """
 
         day_end = date.today()
         day_start = day_end - timedelta(POSTS_PER_DAY_RANGE)
 
         day_time_start = timezone.make_aware(datetime.combine(
             day_start, dtime()), timezone.get_current_timezone())
         day_time_end = timezone.make_aware(datetime.combine(
             day_end, dtime()), timezone.get_current_timezone())
 
         posts_per_period = float(self.filter(
             pub_time__lte=day_time_end,
             pub_time__gte=day_time_start).count())
 
         ppd = posts_per_period / POSTS_PER_DAY_RANGE
 
         return ppd
     
 
 class Post(models.Model, Viewable):
     """A post is a message."""
 
     objects = PostManager()
 
     class Meta:
         app_label = APP_LABEL_BOARDS
         ordering = ('id',)
 
     title = models.CharField(max_length=TITLE_MAX_LENGTH, null=True, blank=True)
     pub_time = models.DateTimeField()
     text = TextField(blank=True, null=True)
     _text_rendered = TextField(blank=True, null=True, editable=False)
 
     images = models.ManyToManyField(PostImage, null=True, blank=True,
                                     related_name='post_images', db_index=True)
+    attachments = models.ManyToManyField(Attachment, null=True, blank=True,
+            related_name='attachment_posts')
 
     poster_ip = models.GenericIPAddressField()
 
     # TODO This field can be removed cause UID is used for update now
     last_edit_time = models.DateTimeField()
 
     referenced_posts = models.ManyToManyField('Post', symmetrical=False,
                                               null=True,
                                               blank=True, related_name='refposts',
                                               db_index=True)
     refmap = models.TextField(null=True, blank=True)
     threads = models.ManyToManyField('Thread', db_index=True)
     thread = models.ForeignKey('Thread', db_index=True, related_name='pt+')
 
     url = models.TextField()
     uid = models.TextField(db_index=True)
 
     def __str__(self):
         return 'P#{}/{}'.format(self.id, self.title)
 
     def get_referenced_posts(self):
         threads = self.get_threads().all()
         return self.referenced_posts.filter(threads__in=threads)\
                 .order_by('pub_time').distinct().all()
 
     def get_title(self) -> str:
         """
         Gets original post title or part of its text.
         """
 
         title = self.title
         if not title:
             title = self.get_text()
 
         return title
 
     def build_refmap(self) -> None:
         """
         Builds a replies map string from replies list. This is a cache to stop
         the server from recalculating the map on every post show.
         """
 
         post_urls = [REFMAP_STR.format(refpost.get_absolute_url(), refpost.id)
                      for refpost in self.referenced_posts.all()]
 
         self.refmap = ', '.join(post_urls)
 
     def is_referenced(self) -> bool:
         return self.refmap and len(self.refmap) > 0
 
     def is_opening(self) -> bool:
         """
         Checks if this is an opening post or just a reply.
         """
 
         return self.get_thread().get_opening_post_id() == self.id
 
     def get_absolute_url(self):
         if self.url:
             return self.url
         else:
             opening_id = self.get_thread().get_opening_post_id()
             post_url = reverse('thread', kwargs={'post_id': opening_id})
             if self.id != opening_id:
                 post_url += '#' + str(self.id)
             return post_url
 
 
     def get_thread(self):
         return self.thread
 
     def get_threads(self) -> QuerySet:
         """
         Gets post's thread.
         """
 
         return self.threads
 
     def get_view(self, *args, **kwargs) -> str:
         """
         Renders post's HTML view. Some of the post params can be passed over
         kwargs for the means of caching (if we view the thread, some params
         are same for every post and don't need to be computed over and over.
         """
 
         thread = self.get_thread()
         is_opening = kwargs.get(PARAMETER_IS_OPENING, self.is_opening())
 
         if is_opening:
             opening_post_id = self.id
         else:
             opening_post_id = thread.get_opening_post_id()
 
         css_class = 'post'
         if thread.archived:
             css_class += ' archive_post'
         elif not thread.can_bump():
             css_class += ' dead_post'
 
         params = dict()
         for param in POST_VIEW_PARAMS:
             if param in kwargs:
                 params[param] = kwargs[param]
 
         params.update({
             PARAMETER_POST: self,
             PARAMETER_IS_OPENING: is_opening,
             PARAMETER_THREAD: thread,
             PARAMETER_CSS_CLASS: css_class,
             PARAMETER_OP_ID: opening_post_id,
         })
 
         return render_to_string('boards/post.html', params)
 
     def get_search_view(self, *args, **kwargs):
         return self.get_view(need_op_data=True, *args, **kwargs)
 
     def get_first_image(self) -> PostImage:
         return self.images.earliest('id')
 
     def delete(self, using=None):
         """
         Deletes all post images and the post itself.
         """
 
         for image in self.images.all():
             image_refs_count = Post.objects.filter(images__in=[image]).count()
             if image_refs_count == 1:
                 image.delete()
 
         thread = self.get_thread()
         thread.last_edit_time = timezone.now()
         thread.save()
 
         super(Post, self).delete(using)
 
         logging.getLogger('boards.post.delete').info(
             'Deleted post {}'.format(self))
 
     def get_post_data(self, format_type=DIFF_TYPE_JSON, request=None,
                       include_last_update=False) -> str:
         """
         Gets post HTML or JSON data that can be rendered on a page or used by
         API.
         """
 
         return get_exporter(format_type).export(self, request,
                                                 include_last_update)
 
     def notify_clients(self, recursive=True):
         """
         Sends post HTML data to the thread web socket.
         """
 
         if not settings.get_bool('External', 'WebsocketsEnabled'):
             return
 
         thread_ids = list()
         for thread in self.get_threads().all():
             thread_ids.append(thread.id)
 
             thread.notify_clients()
 
         if recursive:
             for reply_number in re.finditer(REGEX_REPLY, self.get_raw_text()):
                 post_id = reply_number.group(1)
 
                 try:
                     ref_post = Post.objects.get(id=post_id)
 
                     if ref_post.get_threads().exclude(id__in=thread_ids).exists():
                         # If post is in this thread, its thread was already notified.
                         # Otherwise, notify its thread separately.
                         ref_post.notify_clients(recursive=False)
                 except ObjectDoesNotExist:
                     pass
 
     def build_url(self):
         self.url = self.get_absolute_url()
         self.save(update_fields=['url'])
 
     def save(self, force_insert=False, force_update=False, using=None,
              update_fields=None):
         self._text_rendered = Parser().parse(self.get_raw_text())
 
         self.uid = str(uuid.uuid4())
         if update_fields is not None and 'uid' not in update_fields:
             update_fields += ['uid']
 
         if self.id:
             for thread in self.get_threads().all():
                 thread.last_edit_time = self.last_edit_time
 
                 thread.save(update_fields=['last_edit_time', 'bumpable'])
 
         super().save(force_insert, force_update, using, update_fields)
 
     def get_text(self) -> str:
         return self._text_rendered
 
     def get_raw_text(self) -> str:
         return self.text
 
     def get_absolute_id(self) -> str:
         """
         If the post has many threads, shows its main thread OP id in the post
         ID.
         """
 
         if self.get_threads().count() > 1:
             return '{}/{}'.format(self.get_thread().get_opening_post_id(), self.id)
         else:
             return str(self.id)
 
     def connect_notifications(self):
         for reply_number in re.finditer(REGEX_NOTIFICATION, self.get_raw_text()):
             user_name = reply_number.group(1).lower()
             Notification.objects.get_or_create(name=user_name, post=self)
 
     def connect_replies(self):
         """
         Connects replies to a post to show them as a reflink map
         """
 
         for reply_number in re.finditer(REGEX_REPLY, self.get_raw_text()):
             post_id = reply_number.group(1)
 
             try:
                 referenced_post = Post.objects.get(id=post_id)
 
                 referenced_post.referenced_posts.add(self)
                 referenced_post.last_edit_time = self.pub_time
                 referenced_post.build_refmap()
                 referenced_post.save(update_fields=['refmap', 'last_edit_time'])
             except ObjectDoesNotExist:
                 pass
 
     def connect_threads(self, opening_posts):
         for opening_post in opening_posts:
             threads = opening_post.get_threads().all()
             for thread in threads:
                 if thread.can_bump():
                     thread.update_bump_status()
 
                 thread.last_edit_time = self.last_edit_time
                 thread.save(update_fields=['last_edit_time', 'bumpable'])
             self.threads.add(opening_post.get_thread())

boards/templates/boards/post.html

@@ -1,103 +1,110 b''
 {% load i18n %}
 {% load board %}
 
 {% get_current_language as LANGUAGE_CODE %}
 
 <div class="{{ css_class }}" id="{{ post.id }}" data-uid="{{ post.uid }}">
     <div class="post-info">
         <a class="post_id" href="{{ post.get_absolute_url }}">#{{ post.get_absolute_id }}</a>
         <span class="title">{{ post.title }}</span>
         <span class="pub_time"><time datetime="{{ post.pub_time|date:'c' }}">{{ post.pub_time }}</time></span>
         {% comment %}
             Thread death time needs to be shown only if the thread is alredy archived
             and this is an opening post (thread death time) or a post for popup
             (we don't see OP here so we show the death time in the post itself).
         {% endcomment %}
         {% if thread.archived %}
             {% if is_opening %}
             — <time datetime="{{ thread.bump_time|date:'c' }}">{{ thread.bump_time }}</time>
             {% endif %}
         {% endif %}
         {% if is_opening %}
             {% if need_open_link %}
                 {% if thread.archived %}
                     <a class="link" href="{% url 'thread' post.id %}">{% trans "Open" %}</a>
                 {% else %}
                     <a class="link" href="{% url 'thread' post.id %}#form">{% trans "Reply" %}</a>
                 {% endif %}
             {% endif %}
         {% else %}
             {% if need_op_data %}
                 {% with thread.get_opening_post as op %}
                     {% trans " in " %}<a href="{{ op.get_absolute_url }}">&gt;&gt;{{ op.id }}</a> <span class="title">{{ op.get_title|striptags|truncatewords:5 }}</span>
                 {% endwith %}
             {% endif %}
         {% endif %}
         {% if reply_link and not thread.archived %}
             <a href="#form" onclick="addQuickReply('{{ post.id }}'); return false;">{% trans 'Reply' %}</a>
         {% endif %}
 
         {% if moderator %}
             <span class="moderator_info">
                 | <a href="{% url 'admin:boards_post_change' post.id %}">{% trans 'Edit' %}</a>
                 {% if is_opening %}
                    | <a href="{% url 'admin:boards_thread_change' thread.id %}">{% trans 'Edit thread' %}</a>
                 {% endif %}
             </span>
         {% endif %}
     </div>
     {% comment %}
         Post images. Currently only 1 image can be posted and shown, but post model
         supports multiple.
     {%  endcomment %}
     {% if post.images.exists %}
-        {% with post.images.all.0 as image %}
+        {% with post.images.first as image %}
             {% autoescape off %}
                 {{ image.get_view }}
             {% endautoescape %}
         {% endwith %}
     {% endif %}
+    {% if post.attachments.exists %}
+        {% with post.attachments.first as file %}
+            {% autoescape off %}
+                {{ file.get_view }}
+            {% endautoescape %}
+        {% endwith %}
+    {% endif %}
     {% comment %}
         Post message (text)
     {% endcomment %}
     <div class="message">
         {% autoescape off %}
             {% if truncated %}
                 {{ post.get_text|truncatewords_html:50 }}
             {% else %}
                 {{ post.get_text }}
             {% endif %}
         {% endautoescape %}
         {% if post.is_referenced %}
             {% if mode_tree %}
                 <div class="tree_reply">
                     {% for refpost in post.get_referenced_posts %}
                         {% post_view refpost mode_tree=True %}
                     {% endfor %}
                 </div>
             {% else %}
                 <div class="refmap">
                     {% autoescape off %}
                         {% trans "Replies" %}: {{ post.refmap }}
                     {% endautoescape %}
                 </div>
             {% endif %}
         {% endif %}
     </div>
     {% comment %}
         Thread metadata: counters, tags etc
     {% endcomment %}
     {% if is_opening %}
         <div class="metadata">
             {% if is_opening and need_open_link %}
                 {{ thread.get_reply_count }} {% trans 'messages' %},
                 {{ thread.get_images_count }} {% trans 'images' %}.
             {% endif %}
             <span class="tags">
                 {% autoescape off %}
                     {{ thread.get_tag_url_list }}
                 {% endautoescape %}
             </span>
         </div>
     {% endif %}
 </div>

boards/views/all_threads.py

@@ -1,169 +1,169 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
 import requests
 
 from boards import utils, settings
 from boards.abstracts.paginator import get_paginator
 from boards.abstracts.settingsmanager import get_settings_manager
 from boards.forms import ThreadForm, PlainErrorList
 from boards.models import Post, Thread, Ban, Tag, PostImage, Banner
 from boards.views.banned import BannedView
 from boards.views.base import BaseBoardView, CONTEXT_FORM
 from boards.views.posting_mixin import PostMixin
 
 
 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_BANNERS = 'banners'
 
 PARAMETER_PREV_LINK = 'prev_page_link'
 PARAMETER_NEXT_LINK = 'next_page_link'
 
 TEMPLATE = 'boards/all_threads.html'
 DEFAULT_PAGE = 1
 
 
 class AllThreadsView(PostMixin, BaseBoardView):
 
     def __init__(self):
         self.settings_manager = None
         super(AllThreadsView, self).__init__()
 
     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)
         paginator = get_paginator(self.get_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_BANNERS] = Banner.objects.order_by('-id').all()
 
         self.get_page_context(paginator, params, page)
 
         return render(request, TEMPLATE, params)
 
     def post(self, request):
         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
         if current_page.has_previous():
             params[PARAMETER_PREV_LINK] = self.get_previous_page_link(
                     current_page)
         if current_page.has_next():
             params[PARAMETER_NEXT_LINK] = self.get_next_page_link(current_page)
 
     def get_previous_page_link(self, current_page):
         return reverse('index') + '?page=' \
                 + str(current_page.previous_page_number())
 
     def get_next_page_link(self, current_page):
         return reverse('index') + '?page=' \
                 + str(current_page.next_page_number())
 
     @staticmethod
     def parse_tags_string(tag_strings):
         """
         Parses tag list string and returns tag object list.
         """
 
         tags = []
 
         if tag_strings:
             tag_strings = tag_strings.split(TAG_DELIMITER)
             for tag_name in tag_strings:
                 tag_name = tag_name.strip().lower()
                 if len(tag_name) > 0:
                     tag, created = Tag.objects.get_or_create(name=tag_name)
                     tags.append(tag)
 
         return tags
 
     @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 = data[FORM_TITLE]
         text = data[FORM_TEXT]
-        image = form.get_image()
+        file = form.get_file()
         threads = data[FORM_THREADS]
 
         text = self._remove_invalid_links(text)
 
         tag_strings = data[FORM_TAGS]
 
         tags = self.parse_tags_string(tag_strings)
 
-        post = Post.objects.create_post(title=title, text=text, image=image,
+        post = Post.objects.create_post(title=title, text=text, file=file,
                                         ip=ip, tags=tags, opening_posts=threads)
 
         # This is required to update the threads to which posts we have replied
         # when creating this one
         post.notify_clients()
 
         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.order_by('-bump_time')\
             .exclude(tags__in=self.settings_manager.get_hidden_tags())

boards/views/thread/thread.py

@@ -1,138 +1,138 b''
 from django.core.exceptions import ObjectDoesNotExist
 from django.http import Http404
 from django.shortcuts import get_object_or_404, render, redirect
 from django.views.generic.edit import FormMixin
 from django.utils import timezone
 from django.utils.dateformat import format
 
 from boards import utils, settings
 from boards.forms import PostForm, PlainErrorList
 from boards.models import Post
 from boards.views.base import BaseBoardView, CONTEXT_FORM
 from boards.views.posting_mixin import PostMixin
 
 import neboard
 
 
 CONTEXT_LASTUPDATE = "last_update"
 CONTEXT_THREAD = 'thread'
 CONTEXT_WS_TOKEN = 'ws_token'
 CONTEXT_WS_PROJECT = 'ws_project'
 CONTEXT_WS_HOST = 'ws_host'
 CONTEXT_WS_PORT = 'ws_port'
 CONTEXT_WS_TIME = 'ws_token_time'
 CONTEXT_MODE = 'mode'
 CONTEXT_OP = 'opening_post'
 
 FORM_TITLE = 'title'
 FORM_TEXT = 'text'
 FORM_IMAGE = 'image'
 FORM_THREADS = 'threads'
 
 
 class ThreadView(BaseBoardView, PostMixin, FormMixin):
 
     def get(self, request, post_id, form: PostForm=None):
         try:
             opening_post = Post.objects.get(id=post_id)
         except ObjectDoesNotExist:
             raise Http404
 
         # If this is not OP, don't show it as it is
         if not opening_post.is_opening():
             return redirect(opening_post.get_thread().get_opening_post()
                 .get_absolute_url())
 
         if not form:
             form = PostForm(error_class=PlainErrorList)
 
         thread_to_show = opening_post.get_thread()
 
         params = dict()
 
         params[CONTEXT_FORM] = form
         params[CONTEXT_LASTUPDATE] = str(thread_to_show.last_edit_time)
         params[CONTEXT_THREAD] = thread_to_show
         params[CONTEXT_MODE] = self.get_mode()
         params[CONTEXT_OP] = opening_post
 
         if settings.get_bool('External', 'WebsocketsEnabled'):
             token_time = format(timezone.now(), u'U')
 
             params[CONTEXT_WS_TIME] = token_time
             params[CONTEXT_WS_TOKEN] = utils.get_websocket_token(
                 timestamp=token_time)
             params[CONTEXT_WS_PROJECT] = neboard.settings.CENTRIFUGE_PROJECT_ID
             params[CONTEXT_WS_HOST] = request.get_host().split(':')[0]
             params[CONTEXT_WS_PORT] = neboard.settings.CENTRIFUGE_PORT
 
         params.update(self.get_data(thread_to_show))
 
         return render(request, self.get_template(), params)
 
     def post(self, request, post_id):
         opening_post = get_object_or_404(Post, id=post_id)
 
         # If this is not OP, don't show it as it is
         if not opening_post.is_opening():
             raise Http404
 
         if not opening_post.get_thread().archived:
             form = PostForm(request.POST, request.FILES,
                             error_class=PlainErrorList)
             form.session = request.session
 
             if form.is_valid():
                 return self.new_post(request, form, opening_post)
             if form.need_to_ban:
                 # Ban user because he is suspected to be a bot
                 self._ban_current_user(request)
 
             return self.get(request, post_id, form)
 
     def new_post(self, request, form: PostForm, opening_post: Post=None,
                  html_response=True):
         """
         Adds a new post (in thread or as a reply).
         """
 
         ip = utils.get_client_ip(request)
 
         data = form.cleaned_data
 
         title = data[FORM_TITLE]
         text = data[FORM_TEXT]
-        image = form.get_image()
+        file = form.get_file()
         threads = data[FORM_THREADS]
 
         text = self._remove_invalid_links(text)
 
         post_thread = opening_post.get_thread()
 
-        post = Post.objects.create_post(title=title, text=text, image=image,
+        post = Post.objects.create_post(title=title, text=text, file=file,
                                         thread=post_thread, ip=ip,
                                         opening_posts=threads)
         post.notify_clients()
 
         if html_response:
             if opening_post:
                 return redirect(post.get_absolute_url())
         else:
             return post
 
     def get_data(self, thread) -> dict:
         """
         Returns context params for the view.
         """
 
         return dict()
 
     def get_template(self) -> str:
         """
         Gets template to show the thread mode on.
         """
 
         pass
 
     def get_mode(self) -> str:
         pass