3 |
16 |
--------------------------------------------------------------------------------
/.github/workflows/python-publish.yml:
--------------------------------------------------------------------------------
1 | # This workflow will upload a Python Package using Twine when a release is created
2 | # For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
3 |
4 | name: Upload Python Package
5 |
6 | on:
7 | release:
8 | types: [created]
9 |
10 | jobs:
11 | deploy:
12 | if: startsWith(github.ref, 'refs/tags/v')
13 | runs-on: ubuntu-latest
14 | steps:
15 | - uses: actions/checkout@v2
16 | - name: Set up Python
17 | uses: actions/setup-python@v2
18 | with:
19 | python-version: '3.x'
20 | - name: Install dependencies
21 | run: |
22 | python -m pip install --upgrade pip
23 | pip install setuptools wheel twine build
24 | - name: Build and publish
25 | env:
26 | TWINE_USERNAME: __token__
27 | TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
28 | run: |
29 | python -m build --sdist
30 | twine upload dist/*
31 |
--------------------------------------------------------------------------------
/tellme/mail.py:
--------------------------------------------------------------------------------
1 | from django.conf import settings
2 | from django.core.mail import send_mail as django_send_mail
3 | from django.utils.translation import gettext_lazy as _
4 | try:
5 | from django.core.urlresolvers import reverse
6 | except ImportError:
7 | from django.urls import reverse
8 |
9 |
10 | def send_mail(request, feedback, fail_silently=True):
11 | message = _("Your site %(host)s received feedback from %(user)s.\n"
12 | "The comments were:\n"
13 | "%(note)s.\n\n"
14 | "See the full feedback content here: %(url)s")\
15 | % {'host': request.get_host(), 'user': str(request.user), 'note': feedback.comment,
16 | 'url': request.build_absolute_uri(
17 | reverse('admin:tellme_feedback_change', args=(feedback.id,)))}
18 | django_send_mail(
19 | _('[%(host)s] Received feedback') % {'host': request.get_host()},
20 | message,
21 | settings.SERVER_EMAIL,
22 | [settings.TELLME_FEEDBACK_EMAIL],
23 | fail_silently=fail_silently)
24 |
--------------------------------------------------------------------------------
/tellme/migrations/0001_initial.py:
--------------------------------------------------------------------------------
1 | # -*- coding: utf-8 -*-
2 | from __future__ import unicode_literals
3 |
4 | from django.db import migrations, models
5 | import django.db.models.deletion
6 | from django.conf import settings
7 |
8 |
9 | class Migration(migrations.Migration):
10 |
11 | dependencies = [
12 | migrations.swappable_dependency(settings.AUTH_USER_MODEL),
13 | ]
14 |
15 | operations = [
16 | migrations.CreateModel(
17 | name='Feedback',
18 | fields=[
19 | ('id', models.AutoField(primary_key=True, verbose_name='ID', auto_created=True, serialize=False)),
20 | ('url', models.CharField(max_length=255)),
21 | ('browser', models.TextField()),
22 | ('comment', models.TextField()),
23 | ('screenshot', models.ImageField(upload_to='tellme/screenshots/', null=True, blank=True)),
24 | ('created', models.DateTimeField(auto_now_add=True)),
25 | ('user', models.ForeignKey(null=True, on_delete=django.db.models.deletion.SET_NULL, to=settings.AUTH_USER_MODEL, blank=True)),
26 | ],
27 | ),
28 | ]
29 |
--------------------------------------------------------------------------------
/tellme/templates/tellme/tpl-highlighter.html:
--------------------------------------------------------------------------------
1 | {% load i18n %}
2 | {% trans 'Feedback' %}
4 | {% trans 'Feedback lets you send us suggestions about this site. We welcome problem reports, feature ideas and general comments.' %}
5 | {% if not user.is_authenticated %} 6 |{% trans 'If you wish to be contacted please leave us your email:' %}
7 | 8 | {% endif %} 9 |{% trans 'Start by writing a brief description:' %}
10 | 11 |{% trans "Next we'll let you identify areas of the page related to your description." %}
12 | 13 |{% trans 'Please enter a description.' %}
14 |
15 |
3 |
--------------------------------------------------------------------------------
/tox.ini:
--------------------------------------------------------------------------------
1 | [pytest]
2 | addopts=--tb=short
3 |
4 | [tox]
5 | requires = tox-gh-actions
6 |
7 | toxworkdir = {homedir}/.toxworkdir
8 |
9 | envlist =
10 | py36-django{111,22,30,31}
11 | py37-django{111,22,30,31}
12 | py38-django{22,30,31}
13 | py39-django{22,30,31,master}
14 | lint
15 |
16 | [gh-actions]
17 | python =
18 | 3.6: py36
19 | 3.7: py37
20 | 3.8: py38
21 | 3.9: py39
22 |
23 | [gh-actions:env]
24 | DJANGO =
25 | 111: django111
26 | 22: django22
27 | 30: django30
28 | 31: django31
29 | master: djangomaster
30 |
31 | [testenv]
32 | commands = ./runtests.py
33 |
34 | skip_missing_interpreters=true
35 | basepython =
36 | py39: python3.9
37 | py38: python3.8
38 | py37: python3.7
39 | py36: python3.6
40 |
41 | deps =
42 | -rrequirements-tests.txt
43 | Pillow
44 | django111: Django>=1.11,<2.0
45 | django22: Django>=2.2,<2.3
46 | django30: Django>=3.0,<3.1
47 | django31: Django>=3.1,<3.2
48 | djangomaster: https://github.com/django/django/archive/master.tar.gz
49 |
50 | [testenv:lint]
51 | deps =
52 | -rrequirements.txt
53 | prospector
54 | commands = prospector faker_cloud -0
--------------------------------------------------------------------------------
/tellme/tests/test_models.py:
--------------------------------------------------------------------------------
1 | from unittest import mock
2 | from django.test import TestCase
3 | from tellme.models import Feedback
4 | from tellme.tests.factories import FeedbackFactory
5 |
6 | try:
7 | from django.core.urlresolvers import reverse
8 | except ImportError:
9 | from django.urls import reverse
10 |
11 |
12 | class FeedbackScreenshotMethodsTest(TestCase):
13 | @mock.patch('tellme.models.reverse', wraps=reverse)
14 | def test_get_screenshot_url(self, mocked_reverse):
15 | feedback = FeedbackFactory()
16 | url = feedback.get_screenshot_url()
17 | self.assertEqual(url, '/tellme/get_feedback_screenshot/%s/' % feedback.pk)
18 | mocked_reverse.assert_called_once_with('tellme:get_feedback_screenshot', kwargs={'pk': feedback.pk})
19 |
20 |
21 | class FeedbackScreenshotDeleteTest(TestCase):
22 | def test_delete_screenshot(self):
23 | feedback = FeedbackFactory()
24 | self.assertTrue(feedback.screenshot)
25 | feedback.delete()
26 | self.assertFalse(feedback.screenshot)
27 |
28 | def test_no_screenshot(self):
29 | feedback = FeedbackFactory(screenshot=None)
30 | feedback.delete()
31 | self.assertFalse(feedback.screenshot)
--------------------------------------------------------------------------------
/tellme/templates/tellme/tpl-overview.html:
--------------------------------------------------------------------------------
1 | {% load i18n %}
2 | {% trans 'Feedback' %}
4 | {% trans "Click and drag on the page to help us better understand your feedback. You can move this dialog if it's in the way." %}
5 | 8 | 9 | 12 | 13 | 21 | 22 |
3 |
14 |
18 |
--------------------------------------------------------------------------------
/setup.py:
--------------------------------------------------------------------------------
1 | import os
2 | from setuptools import setup
3 |
4 | with open(os.path.join(os.path.dirname(__file__), 'README.rst')) as readme:
5 | README = readme.read()
6 |
7 | # allow setup.py to be run from any path
8 | os.chdir(os.path.normpath(os.path.join(os.path.abspath(__file__), os.pardir)))
9 |
10 | setup(
11 | name='django-tellme',
12 | version='0.7.3',
13 | packages=['tellme'],
14 | include_package_data=True,
15 | license='BSD License',
16 | description='A simple Django app that enables user feedback.',
17 | long_description=README,
18 | url='https://github.com/ludrao/django-tellme',
19 | author='Ludrao',
20 | author_email='ludrao@ludrao.net',
21 | classifiers=[
22 | 'Development Status :: 4 - Beta',
23 | 'Environment :: Web Environment',
24 | 'Framework :: Django',
25 | 'Intended Audience :: Developers',
26 | 'License :: OSI Approved :: BSD License',
27 | 'Operating System :: OS Independent',
28 | 'Programming Language :: Python',
29 | 'Programming Language :: Python :: 3',
30 | 'Programming Language :: Python :: 3.2',
31 | 'Programming Language :: Python :: 3.3',
32 | 'Programming Language :: Python :: 3.5',
33 | 'Topic :: Internet :: WWW/HTTP',
34 | 'Topic :: Internet :: WWW/HTTP :: Dynamic Content',
35 | ],
36 | )
37 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Copyright (c) 1998, Ludrao
2 | All rights reserved.
3 | Redistribution and use in source and binary forms, with or without
4 | modification, are permitted provided that the following conditions are met:
5 |
6 | * Redistributions of source code must retain the above copyright
7 | notice, this list of conditions and the following disclaimer.
8 | * Redistributions in binary form must reproduce the above copyright
9 | notice, this list of conditions and the following disclaimer in the
10 | documentation and/or other materials provided with the distribution.
11 | * Neither the name of the University of California, Berkeley nor the
12 | names of its contributors may be used to endorse or promote products
13 | derived from this software without specific prior written permission.
14 |
15 | THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
16 | EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17 | WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18 | DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
19 | DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20 | (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21 | LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
22 | ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 | (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
24 | SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
--------------------------------------------------------------------------------
/tellme/tests/test_admin.py:
--------------------------------------------------------------------------------
1 | from django.test import TestCase
2 | try:
3 | from django.core.urlresolvers import reverse_lazy as reverse
4 | except ImportError:
5 | from django.urls import reverse_lazy as reverse
6 |
7 | from tellme.models import Feedback
8 | from tellme.tests import factories
9 |
10 |
11 | class AdminAcknowledgeActionTest(TestCase):
12 | url = reverse('admin:tellme_feedback_changelist')
13 |
14 | def test_action(self):
15 | user = factories.UserFactory(is_staff=True, is_superuser=True)
16 | feedback = factories.FeedbackFactory(ack=False)
17 | self.client.force_login(user)
18 | data = {
19 | 'action': 'acknowledge',
20 | '_selected_action': [feedback.id],
21 | }
22 | response = self.client.post(self.url, data, follow=True)
23 | self.assertEqual(response.status_code, 200)
24 | feedback.refresh_from_db()
25 | self.assertTrue(feedback.ack)
26 |
27 |
28 | class AdminUnacknowledgeActionTest(TestCase):
29 | url = reverse('admin:tellme_feedback_changelist')
30 |
31 | def test_action(self):
32 | user = factories.UserFactory(is_staff=True, is_superuser=True)
33 | feedback = factories.FeedbackFactory(ack=True)
34 | self.client.force_login(user)
35 | data = {
36 | 'action': 'unacknowledge',
37 | '_selected_action': [feedback.id],
38 | }
39 | response = self.client.post(self.url, data, follow=True)
40 | self.assertEqual(response.status_code, 200)
41 | feedback.refresh_from_db()
42 | self.assertFalse(feedback.ack)
43 |
--------------------------------------------------------------------------------
/tellme/tests/testproject/settings.py:
--------------------------------------------------------------------------------
1 | import os
2 |
3 | BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
4 | SECRET_KEY = "Shuuut... It's a secret"
5 |
6 | DEBUG = False
7 | ALLOWED_HOSTS = ['*']
8 | INSTALLED_APPS = [
9 | 'django.contrib.contenttypes',
10 | 'django.contrib.auth',
11 | 'django.contrib.messages',
12 | 'django.contrib.sessions',
13 | 'django.contrib.admin',
14 | 'tellme',
15 | ]
16 |
17 | MIDDLEWARE = [
18 | 'django.contrib.sessions.middleware.SessionMiddleware',
19 | 'django.contrib.auth.middleware.AuthenticationMiddleware',
20 | 'django.contrib.messages.middleware.MessageMiddleware',
21 | ]
22 |
23 | ROOT_URLCONF = 'tellme.tests.testproject.urls'
24 |
25 | TEMPLATES = [
26 | {
27 | 'BACKEND': 'django.template.backends.django.DjangoTemplates',
28 | 'DIRS': [],
29 | 'APP_DIRS': True,
30 | 'OPTIONS': {
31 | 'context_processors': [
32 | 'django.contrib.auth.context_processors.auth',
33 | 'django.contrib.messages.context_processors.messages',
34 | ],
35 | },
36 | },
37 | ]
38 |
39 | WSGI_APPLICATION = 'tellme.tests.testproject.wsgi.application'
40 |
41 | DATABASES = {
42 | 'default': {
43 | 'ENGINE': 'django.db.backends.sqlite3',
44 | 'NAME': os.environ.get('DATABASE_PATH', ':memory:'),
45 | }
46 | }
47 |
48 | AUTH_PASSWORD_VALIDATORS = []
49 |
50 | LANGUAGE_CODE = 'en-us'
51 | TIME_ZONE = 'UTC'
52 | USE_I18N = True
53 | USE_L10N = True
54 | USE_TZ = True
55 | STATIC_URL = '/static/'
56 |
57 | TELLME_FEEDBACK_EMAIL = 'foo@bar.ham'
58 |
--------------------------------------------------------------------------------
/tellme/migrations/0002_auto_20160411_2232.py:
--------------------------------------------------------------------------------
1 | # -*- coding: utf-8 -*-
2 | from __future__ import unicode_literals
3 |
4 | from django.db import migrations, models
5 | import django.db.models.deletion
6 | from django.conf import settings
7 |
8 |
9 | class Migration(migrations.Migration):
10 |
11 | dependencies = [
12 | ('tellme', '0001_initial'),
13 | ]
14 |
15 | operations = [
16 | migrations.AlterField(
17 | model_name='feedback',
18 | name='browser',
19 | field=models.TextField(verbose_name='Browser'),
20 | ),
21 | migrations.AlterField(
22 | model_name='feedback',
23 | name='comment',
24 | field=models.TextField(verbose_name='Comment'),
25 | ),
26 | migrations.AlterField(
27 | model_name='feedback',
28 | name='created',
29 | field=models.DateTimeField(auto_now_add=True, verbose_name='Creation date'),
30 | ),
31 | migrations.AlterField(
32 | model_name='feedback',
33 | name='screenshot',
34 | field=models.ImageField(upload_to='tellme/screenshots/', verbose_name='Screenshot', blank=True, null=True),
35 | ),
36 | migrations.AlterField(
37 | model_name='feedback',
38 | name='url',
39 | field=models.CharField(max_length=255, verbose_name='Url'),
40 | ),
41 | migrations.AlterField(
42 | model_name='feedback',
43 | name='user',
44 | field=models.ForeignKey(on_delete=django.db.models.deletion.SET_NULL, blank=True, verbose_name='User', to=settings.AUTH_USER_MODEL, null=True),
45 | ),
46 | ]
47 |
--------------------------------------------------------------------------------
/tellme/models.py:
--------------------------------------------------------------------------------
1 | from django.conf import settings
2 | from django.db import models
3 | from django.db.models.signals import post_delete
4 | from django.dispatch.dispatcher import receiver
5 | from django.utils.translation import gettext_lazy as _
6 | from six import python_2_unicode_compatible
7 |
8 | try:
9 | from django.core.urlresolvers import reverse
10 | except ImportError:
11 | from django.urls import reverse
12 |
13 |
14 | @python_2_unicode_compatible
15 | class Feedback(models.Model):
16 | url = models.CharField(_('Url'), max_length=255)
17 | browser = models.TextField(_('Browser'))
18 | comment = models.TextField(_('Comment'))
19 | screenshot = models.ImageField(_('Screenshot'), blank=True, null=True, upload_to="tellme/screenshots/")
20 |
21 | user = models.ForeignKey(settings.AUTH_USER_MODEL, verbose_name=_("User"), on_delete=models.SET_NULL, blank=True, null=True)
22 | email = models.EmailField(max_length=254, blank=True, null=True)
23 | created = models.DateTimeField(_('Creation date'), auto_now_add=True, db_index=True)
24 |
25 | ack = models.BooleanField(_('Acknowledgement'), default=False)
26 |
27 | class Meta:
28 | verbose_name = _("feedback")
29 | verbose_name_plural = _("feedbacks")
30 |
31 | def __str__(self):
32 | return '%s: %s' % (self.created, self.url)
33 |
34 | def get_screenshot_url(self):
35 | return reverse('tellme:get_feedback_screenshot', kwargs={'pk': self.pk})
36 |
37 |
38 | @receiver(post_delete, sender=Feedback)
39 | def feedback_screenshot_delete(sender, instance, **kwargs):
40 | """
41 | Delete feedback's screenshot.
42 | """
43 | if instance.screenshot:
44 | instance.screenshot.delete(save=False)
45 |
--------------------------------------------------------------------------------
/tellme/views.py:
--------------------------------------------------------------------------------
1 | import json
2 | from base64 import b64decode
3 | import importlib
4 |
5 | from django.conf import settings
6 | from django.http import JsonResponse, HttpResponseBadRequest
7 | from django.core.files.base import ContentFile
8 | from django.shortcuts import redirect, get_object_or_404
9 | from django.utils.crypto import get_random_string
10 |
11 | from tellme.forms import FeedbackForm
12 | from tellme.models import Feedback
13 | from tellme import mail
14 |
15 |
16 | def get_notification_function(path=None):
17 | path = path or getattr(settings, 'TELLME_NOTIFICATION_FUNCTION',
18 | 'tellme.mail.send_mail')
19 | module_path = '.'.join(path.split('.')[:-1])
20 | func_name = path.split('.')[-1]
21 | module = importlib.import_module(module_path)
22 | func = getattr(module, func_name)
23 | return func
24 |
25 |
26 | def post_feedback(request):
27 | if request.method == 'POST' and request.is_ajax():
28 |
29 | # Copy Post data names into names used into the model in order to automatically create the model/form
30 | # from the request dicts
31 | feedback = json.loads(request.POST["feedback"])
32 | if request.user.id:
33 | data = {'url': feedback['url'], 'browser': json.dumps(feedback['browser']), 'comment': feedback['note'],
34 | 'user': request.user.id}
35 | else:
36 | data = {'url': feedback['url'], 'browser': json.dumps(feedback['browser']), 'comment': feedback['note'],
37 | 'email': feedback.get('email')}
38 | imgstr = feedback['img'].split(';base64,')[1]
39 | file = {'screenshot': ContentFile(b64decode(imgstr), name="screenshot_" + get_random_string(6) + ".png")}
40 | form = FeedbackForm(data, file)
41 | # check whether it's valid:
42 | if form.is_valid():
43 | f = form.save()
44 |
45 | if hasattr(settings, 'TELLME_FEEDBACK_EMAIL'):
46 | send_notif = get_notification_function()
47 | send_notif(request, f)
48 | return JsonResponse({})
49 | else:
50 | return JsonResponse({'error': dict(form.errors)})
51 |
52 | else:
53 | return HttpResponseBadRequest()
54 |
55 |
56 | def get_feedback_screenshot(request, pk):
57 | instance = get_object_or_404(Feedback, pk=pk)
58 | return redirect(instance.screenshot.url)
59 |
--------------------------------------------------------------------------------
/tellme/admin.py:
--------------------------------------------------------------------------------
1 | import json
2 |
3 | import django
4 | from django.contrib import admin
5 | from django.contrib import messages
6 | from django.utils.html import escape
7 | from django.utils.translation import gettext_lazy as _, pgettext_lazy
8 | from django.utils.safestring import mark_safe
9 |
10 | from .models import Feedback
11 |
12 |
13 | # Display an html table from a dict
14 | # Credit: original author Rogerio Hilbert
15 | def pretty_items(r, d, nametag="%s: ", itemtag='{% trans 'Feedback' %}
4 |
5 |
12 |
13 | {% trans 'Description' %}
6 |{% trans 'Additional info' %}
7 |{% trans 'None' %}
8 | {% trans 'Browser Info' %}
9 | {% trans 'Page Info' %}
10 | {% trans 'Page Structure' %}
11 | {% trans 'Screenshot' %}
{% trans 'Please enter a description.' %}
19 |
20 | - ', '
Feedback
Feedback lets you send us suggestions about our products. We welcome problem reports, feature ideas and general comments.
Start by writing a brief description:
Next we\'ll let you identify areas of the page related to your description.
Please enter a description.
Feedback
Click and drag on the page to help us better understand your feedback. You can move this dialog if it\'s in the way.
Feedback
Description
Additional info
None
Browser Info
Page Info
Page Structure
Screenshot
Please enter a description.
Feedback
Loading...
Feedback
Thank you for your feedback. We value every piece of feedback we receive.
We cannot respond individually to every one, but we will use your comments as we strive to improve your experience.
Feedback
Sadly an error occured while sending your feedback. Please try again.
';
65 |
66 | if (settings.initialBox) {
67 | tpl += settings.tpl.description;
68 | }
69 |
70 | tpl += settings.tpl.highlighter + settings.tpl.overview + '
';
71 |
72 | $('body').append(tpl);
73 |
74 | moduleStyle = {
75 | 'position': 'absolute',
76 | 'left': '0px',
77 | 'top': '0px'
78 | };
79 | canvasAttr = {
80 | 'width': w,
81 | 'height': h
82 | };
83 |
84 | $('#feedback-module').css(moduleStyle);
85 | $('#feedback-canvas').attr(canvasAttr).css('z-index', '30000');
86 |
87 | if (!settings.initialBox) {
88 | $('#feedback-highlighter-back').remove();
89 | canDraw = true;
90 | $('#feedback-canvas').css('cursor', 'crosshair');
91 | $('#feedback-helpers').show();
92 | $('#feedback-welcome').hide();
93 | $('#feedback-highlighter').show();
94 | }
95 |
96 | if(settings.isDraggable) {
97 | $('#feedback-highlighter').on('mousedown.feedback', function(e) {
98 | var $d = $(this).addClass('feedback-draggable'),
99 | drag_h = $d.outerHeight(),
100 | drag_w = $d.outerWidth(),
101 | pos_y = $d.offset().top + drag_h - e.pageY,
102 | pos_x = $d.offset().left + drag_w - e.pageX;
103 | $d.css('z-index', 40000).parents().on('mousemove.feedback', function(e) {
104 | _top = e.pageY + pos_y - drag_h;
105 | _left = e.pageX + pos_x - drag_w;
106 | _bottom = drag_h - e.pageY;
107 | _right = drag_w - e.pageX;
108 |
109 | if (_left < 0) _left = 0;
110 | if (_top < 0) _top = 0;
111 | if (_right > $(window).width())
112 | _left = $(window).width() - drag_w;
113 | if (_left > $(window).width() - drag_w)
114 | _left = $(window).width() - drag_w;
115 | if (_bottom > $(document).height())
116 | _top = $(document).height() - drag_h;
117 | if (_top > $(document).height() - drag_h)
118 | _top = $(document).height() - drag_h;
119 |
120 | $('.feedback-draggable').offset({
121 | top: _top,
122 | left: _left
123 | }).on("mouseup", function() {
124 | $(this).removeClass('feedback-draggable');
125 | });
126 | });
127 | e.preventDefault();
128 | }).on('mouseup.feedback', function(){
129 | $(this).removeClass('feedback-draggable');
130 | $(this).parents().off('mousemove mousedown');
131 | });
132 | }
133 |
134 | var ctx = $('#feedback-canvas')[0].getContext('2d');
135 |
136 | ctx.fillStyle = 'rgba(102,102,102,0.5)';
137 | ctx.fillRect(0, 0, $('#feedback-canvas').width(), $('#feedback-canvas').height());
138 |
139 | rect = {};
140 | drag = false;
141 | highlight = 1,
142 | post = {};
143 |
144 | if (settings.postBrowserInfo) {
145 | post.browser = {};
146 | post.browser.appCodeName = navigator.appCodeName;
147 | post.browser.appName = navigator.appName;
148 | post.browser.appVersion = navigator.appVersion;
149 | post.browser.cookieEnabled = navigator.cookieEnabled;
150 | post.browser.onLine = navigator.onLine;
151 | post.browser.platform = navigator.platform;
152 | post.browser.userAgent = navigator.userAgent;
153 | post.browser.plugins = [];
154 |
155 | $.each(navigator.plugins, function(i) {
156 | post.browser.plugins.push(navigator.plugins[i].name);
157 | });
158 | $('#feedback-browser-info').show();
159 | }
160 |
161 | if (settings.postURL) {
162 | post.url = document.URL;
163 | $('#feedback-page-info').show();
164 | }
165 |
166 | if (settings.postHTML) {
167 | post.html = $('html').html();
168 | $('#feedback-page-structure').show();
169 | }
170 |
171 | if (!settings.postBrowserInfo && !settings.postURL && !settings.postHTML)
172 | $('#feedback-additional-none').show();
173 |
174 | $(document).on('mousedown.feedback', '#feedback-canvas', function(e) {
175 | if (canDraw) {
176 |
177 | rect.startX = e.pageX - $(this).offset().left;
178 | rect.startY = e.pageY - $(this).offset().top;
179 | rect.w = 0;
180 | rect.h = 0;
181 | drag = true;
182 | }
183 | });
184 |
185 | $(document).on('mouseup.feedback', function(){
186 | if (canDraw) {
187 | drag = false;
188 |
189 | var dtop = rect.startY,
190 | dleft = rect.startX,
191 | dwidth = rect.w,
192 | dheight = rect.h;
193 | dtype = 'highlight';
194 |
195 | if (dwidth == 0 || dheight == 0) return;
196 |
197 | if (dwidth < 0) {
198 | dleft += dwidth;
199 | dwidth *= -1;
200 | }
201 | if (dheight < 0) {
202 | dtop += dheight;
203 | dheight *= -1;
204 | }
205 |
206 | if (dtop + dheight > $(document).height())
207 | dheight = $(document).height() - dtop;
208 | if (dleft + dwidth > $(document).width())
209 | dwidth = $(document).width() - dleft;
210 |
211 | if (highlight == 0)
212 | dtype = 'blackout';
213 |
214 | $('#feedback-helpers').append('');
215 |
216 | redraw(ctx);
217 | rect.w = 0;
218 | }
219 |
220 | });
221 |
222 | $(document).on('mousemove.feedback', function(e) {
223 | if (canDraw && drag) {
224 | $('#feedback-highlighter').css('cursor', 'default');
225 |
226 | rect.w = (e.pageX - $('#feedback-canvas').offset().left) - rect.startX;
227 | rect.h = (e.pageY - $('#feedback-canvas').offset().top) - rect.startY;
228 |
229 | ctx.clearRect(0, 0, $('#feedback-canvas').width(), $('#feedback-canvas').height());
230 | ctx.fillStyle = 'rgba(102,102,102,0.5)';
231 | ctx.fillRect(0, 0, $('#feedback-canvas').width(), $('#feedback-canvas').height());
232 | $('.feedback-helper').each(function() {
233 | if ($(this).attr('data-type') == 'highlight')
234 | drawlines(ctx, parseInt($(this).css('left'), 10), parseInt($(this).css('top'), 10), $(this).width(), $(this).height());
235 | });
236 | if (highlight==1) {
237 | drawlines(ctx, rect.startX, rect.startY, rect.w, rect.h);
238 | ctx.clearRect(rect.startX, rect.startY, rect.w, rect.h);
239 | }
240 | $('.feedback-helper').each(function() {
241 | if ($(this).attr('data-type') == 'highlight')
242 | ctx.clearRect(parseInt($(this).css('left'), 10), parseInt($(this).css('top'), 10), $(this).width(), $(this).height());
243 | });
244 | $('.feedback-helper').each(function() {
245 | if ($(this).attr('data-type') == 'blackout') {
246 | ctx.fillStyle = 'rgba(0,0,0,1)';
247 | ctx.fillRect(parseInt($(this).css('left'), 10), parseInt($(this).css('top'), 10), $(this).width(), $(this).height())
248 | }
249 | });
250 | if (highlight == 0) {
251 | ctx.fillStyle = 'rgba(0,0,0,0.5)';
252 | ctx.fillRect(rect.startX, rect.startY, rect.w, rect.h);
253 | }
254 | }
255 | });
256 |
257 | if (settings.highlightElement) {
258 | var highlighted = [],
259 | tmpHighlighted = [],
260 | hidx = 0;
261 |
262 | $(document).on('mousemove.feedback click.feedback', '#feedback-canvas',function(e) {
263 | if (canDraw) {
264 | redraw(ctx);
265 | tmpHighlighted = [];
266 |
267 | $('#feedback-canvas').css('cursor', 'crosshair');
268 |
269 | $('* :not(body,script,iframe,div,section,.feedback-btn,#feedback-module *)').each(function(){
270 | if ($(this).attr('data-highlighted') === 'true')
271 | return;
272 |
273 | if (e.pageX > $(this).offset().left && e.pageX < $(this).offset().left + $(this).width() && e.pageY > $(this).offset().top + parseInt($(this).css('padding-top'), 10) && e.pageY < $(this).offset().top + $(this).height() + parseInt($(this).css('padding-top'), 10)) {
274 | tmpHighlighted.push($(this));
275 | }
276 | });
277 |
278 | var $toHighlight = tmpHighlighted[tmpHighlighted.length - 1];
279 |
280 | if ($toHighlight && !drag) {
281 | $('#feedback-canvas').css('cursor', 'pointer');
282 |
283 | var _x = $toHighlight.offset().left - 2,
284 | _y = $toHighlight.offset().top - 2,
285 | _w = $toHighlight.width() + parseInt($toHighlight.css('padding-left'), 10) + parseInt($toHighlight.css('padding-right'), 10) + 6,
286 | _h = $toHighlight.height() + parseInt($toHighlight.css('padding-top'), 10) + parseInt($toHighlight.css('padding-bottom'), 10) + 6;
287 |
288 | if (highlight == 1) {
289 | drawlines(ctx, _x, _y, _w, _h);
290 | ctx.clearRect(_x, _y, _w, _h);
291 | dtype = 'highlight';
292 | }
293 |
294 | $('.feedback-helper').each(function() {
295 | if ($(this).attr('data-type') == 'highlight')
296 | ctx.clearRect(parseInt($(this).css('left'), 10), parseInt($(this).css('top'), 10), $(this).width(), $(this).height());
297 | });
298 |
299 | if (highlight == 0) {
300 | dtype = 'blackout';
301 | ctx.fillStyle = 'rgba(0,0,0,0.5)';
302 | ctx.fillRect(_x, _y, _w, _h);
303 | }
304 |
305 | $('.feedback-helper').each(function() {
306 | if ($(this).attr('data-type') == 'blackout') {
307 | ctx.fillStyle = 'rgba(0,0,0,1)';
308 | ctx.fillRect(parseInt($(this).css('left'), 10), parseInt($(this).css('top'), 10), $(this).width(), $(this).height());
309 | }
310 | });
311 |
312 | if (e.type == 'click' && e.pageX == rect.startX && e.pageY == rect.startY) {
313 | $('#feedback-helpers').append('');
314 | highlighted.push(hidx);
315 | ++hidx;
316 | redraw(ctx);
317 | }
318 | }
319 | }
320 | });
321 | }
322 |
323 | $(document).on('mouseleave.feedback', 'body,#feedback-canvas', function() {
324 | redraw(ctx);
325 | });
326 |
327 | $(document).on('mouseenter.feedback', '.feedback-helper', function() {
328 | redraw(ctx);
329 | });
330 |
331 | $(document).on('click.feedback', '#feedback-welcome-next', function() {
332 | if ($('#feedback-note').val().length > 0) {
333 | canDraw = true;
334 | $('#feedback-canvas').css('cursor', 'crosshair');
335 | $('#feedback-helpers').show();
336 | $('#feedback-welcome').hide();
337 | $('#feedback-highlighter').show();
338 | }
339 | else {
340 | $('#feedback-welcome-error').show();
341 | }
342 | });
343 |
344 | $(document).on('mouseenter.feedback mouseleave.feedback', '.feedback-helper', function(e) {
345 | if (drag)
346 | return;
347 |
348 | rect.w = 0;
349 | rect.h = 0;
350 |
351 | if (e.type === 'mouseenter') {
352 | $(this).css('z-index', '30001');
353 | $(this).append('');
354 | $(this).append('');
355 | $(this).find('#feedback-close').css({
356 | 'top' : -1 * ($(this).find('#feedback-close').height() / 2) + 'px',
357 | 'left' : $(this).width() - ($(this).find('#feedback-close').width() / 2) + 'px'
358 | });
359 |
360 | if ($(this).attr('data-type') == 'blackout') {
361 | /* redraw white */
362 | ctx.clearRect(0, 0, $('#feedback-canvas').width(), $('#feedback-canvas').height());
363 | ctx.fillStyle = 'rgba(102,102,102,0.5)';
364 | ctx.fillRect(0, 0, $('#feedback-canvas').width(), $('#feedback-canvas').height());
365 | $('.feedback-helper').each(function() {
366 | if ($(this).attr('data-type') == 'highlight')
367 | drawlines(ctx, parseInt($(this).css('left'), 10), parseInt($(this).css('top'), 10), $(this).width(), $(this).height());
368 | });
369 | $('.feedback-helper').each(function() {
370 | if ($(this).attr('data-type') == 'highlight')
371 | ctx.clearRect(parseInt($(this).css('left'), 10), parseInt($(this).css('top'), 10), $(this).width(), $(this).height());
372 | });
373 |
374 | ctx.clearRect(parseInt($(this).css('left'), 10), parseInt($(this).css('top'), 10), $(this).width(), $(this).height())
375 | ctx.fillStyle = 'rgba(0,0,0,0.75)';
376 | ctx.fillRect(parseInt($(this).css('left'), 10), parseInt($(this).css('top'), 10), $(this).width(), $(this).height());
377 |
378 | ignore = $(this).attr('data-time');
379 |
380 | /* redraw black */
381 | $('.feedback-helper').each(function() {
382 | if ($(this).attr('data-time') == ignore)
383 | return true;
384 | if ($(this).attr('data-type') == 'blackout') {
385 | ctx.fillStyle = 'rgba(0,0,0,1)';
386 | ctx.fillRect(parseInt($(this).css('left'), 10), parseInt($(this).css('top'), 10), $(this).width(), $(this).height())
387 | }
388 | });
389 | }
390 | }
391 | else {
392 | $(this).css('z-index','30000');
393 | $(this).children().remove();
394 | if ($(this).attr('data-type') == 'blackout') {
395 | redraw(ctx);
396 | }
397 | }
398 | });
399 |
400 | $(document).on('click.feedback', '#feedback-close', function() {
401 | if (settings.highlightElement && $(this).parent().attr('data-highlight-id'))
402 | var _hidx = $(this).parent().attr('data-highlight-id');
403 |
404 | $(this).parent().remove();
405 |
406 | if (settings.highlightElement && _hidx)
407 | $('[data-highlight-id="' + _hidx + '"]').removeAttr('data-highlighted').removeAttr('data-highlight-id');
408 |
409 | redraw(ctx);
410 | });
411 |
412 | $('#feedback-module').on('click.feedback', '.feedback-wizard-close,.feedback-close-btn', function() {
413 | close();
414 | });
415 |
416 | $(document).on('keyup.feedback', function(e) {
417 | if (e.keyCode == 27)
418 | close();
419 | });
420 |
421 | $(document).on('selectstart.feedback dragstart.feedback', function(e) {
422 | e.preventDefault();
423 | });
424 |
425 | $(document).on('click.feedback', '#feedback-highlighter-back', function() {
426 | canDraw = false;
427 | $('#feedback-canvas').css('cursor', 'default');
428 | $('#feedback-helpers').hide();
429 | $('#feedback-highlighter').hide();
430 | $('#feedback-welcome-error').hide();
431 | $('#feedback-welcome').show();
432 | });
433 |
434 | $(document).on('mousedown.feedback', '.feedback-sethighlight', function() {
435 | highlight = 1;
436 | $(this).addClass('feedback-active');
437 | $('.feedback-setblackout').removeClass('feedback-active');
438 | });
439 |
440 | $(document).on('mousedown.feedback', '.feedback-setblackout', function() {
441 | highlight = 0;
442 | $(this).addClass('feedback-active');
443 | $('.feedback-sethighlight').removeClass('feedback-active');
444 | });
445 |
446 | $(document).on('click.feedback', '#feedback-highlighter-next', function() {
447 | canDraw = false;
448 | $('#feedback-canvas').css('cursor', 'default');
449 | var sy = $(document).scrollTop(),
450 | dh = $(window).height();
451 | $('#feedback-helpers').hide();
452 | $('#feedback-highlighter').hide();
453 | if (!settings.screenshotStroke) {
454 | redraw(ctx, false);
455 | }
456 | html2canvas($('body'), {
457 | onrendered: function(canvas) {
458 | if (!settings.screenshotStroke) {
459 | redraw(ctx);
460 | }
461 | _canvas = $('').hide().appendTo('body');
462 | _ctx = _canvas.get(0).getContext('2d');
463 | _ctx.drawImage(canvas, 0, sy, w, dh, 0, 0, w, dh);
464 | img = _canvas.get(0).toDataURL();
465 | $(document).scrollTop(sy);
466 | post.img = img;
467 | settings.onScreenshotTaken(post.img);
468 | if(settings.showDescriptionModal) {
469 | $('#feedback-canvas-tmp').remove();
470 | $('#feedback-overview').show();
471 | $('#feedback-overview-description-text>textarea').remove();
472 | $('#feedback-overview-screenshot>img').remove();
473 | $('').insertAfter('#feedback-overview-description-text h3:eq(0)');
474 | $('#feedback-overview-screenshot').append('