Skip to content

feat: remove PDF download button and option #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
samuelallan72 wants to merge 1 commit into from
Closed

feat: remove PDF download button and option #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 1 addition & 23 deletions pdf/pdf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ class PdfBlock(XBlock):
Icon of the XBlock. Values : [other (default), video, problem]
"""
icon_class = "other"
editable_fields = ('display_name', 'url', 'allow_download', 'source_text', 'source_url')
editable_fields = ('display_name', 'url', 'source_text', 'source_url')

# Fields
display_name = String(
Expand All @@ -44,13 +44,6 @@ class PdfBlock(XBlock):
help=_("The URL for your PDF.")
)

allow_download = Boolean(
display_name=_("PDF Download Allowed"),
default=True,
scope=Scope.content,
help=_("Display a download button for this PDF.")
)

source_text = String(
display_name=_("Source document button text"),
default="",
Expand Down Expand Up @@ -97,7 +90,6 @@ def student_view(self, context=None):
context = {
'display_name': self.display_name,
'url': self.url,
'allow_download': self.allow_download,
'disable_all_download': is_all_download_disabled(),
'source_text': self.source_text,
'source_url': self.source_url,
Expand Down Expand Up @@ -129,7 +121,6 @@ def studio_view(self, context=None):
context = {
'display_name': self.display_name,
'url': self.url,
'allow_download': self.allow_download,
'disable_all_download': is_all_download_disabled(),
'source_text': self.source_text,
'source_url': self.source_url,
Expand All @@ -145,18 +136,6 @@ def studio_view(self, context=None):
frag.initialize_js('pdfXBlockInitEdit')
return frag

@XBlock.json_handler
def on_download(self, data, suffix=''): # pylint: disable=unused-argument
"""
The download file event handler
"""
event_type = 'edx.pdf.downloaded'
event_data = {
'url': self.url,
'source_url': self.source_url,
}
self.runtime.publish(self, event_type, event_data)

def _generate_pdf_from_source(self):
"""
Uses the Gotenberg API to convert the source document to a PDF.
Expand All @@ -178,7 +157,6 @@ def save_pdf(self, data, suffix=''): # pylint: disable=unused-argument
self.url = data['url']

if not is_all_download_disabled():
self.allow_download = bool_from_str(data['allow_download'])
self.source_text = data['source_text']
self.source_url = data['source_url']
if data['source_url'] and bool_from_str(data['pdf_auto_generate']):
Expand Down
1 change: 0 additions & 1 deletion pdf/static/js/pdf_edit.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ function pdfXBlockInitEdit(runtime, element) {
const data = {
'display_name': $('#pdf_edit_display_name').val(),
'url': $('#pdf_edit_url').val(),
'allow_download': $('#pdf_edit_allow_download').val() || '',
'source_text': $('#pdf_edit_source_text').val() || '',
'source_url': $('#pdf_edit_source_url').val() || '',
'pdf_auto_generate': $('#pdf_auto_generate').val() || '',
Expand Down
7 changes: 0 additions & 7 deletions pdf/static/js/pdf_view.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,4 @@ function pdfXBlockInitView(runtime, element) {
if (element.innerHTML) {
element = $(element);
}

$(function () {
element.find('.pdf-download-button').on('click', function () {
const handlerUrl = runtime.handlerUrl(element, 'on_download');
$.post(handlerUrl, '{}');
});
});
}
11 changes: 0 additions & 11 deletions pdf/templates/html/pdf_edit.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,6 @@
</li>

{% if not disable_all_download %}
<li class="field comp-setting-entry is-set">
<div class="wrapper-comp-setting">
<label class="label setting-label" for="pdf_edit_allow_download">{% trans "PDF Download Allowed" %}</label>
<select class="input setting-input" id="pdf_edit_allow_download">
<option value="True" {% if allow_download %}selected{% endif %}>{% trans "True" %}</option>
<option value="False" {% if not allow_download %}selected{% endif %}>{% trans "False" %}</option>
</select>
</div>
<span class="tip setting-help">{% trans "Display a download button for this PDF." %}</span>
</li>

<li class="field comp-setting-entry is-set">
<div class="wrapper-comp-setting">
<label class="label setting-label" for="pdf_edit_source_text">{% trans "Source document button text" %}</label>
Expand Down
5 changes: 0 additions & 5 deletions pdf/templates/html/pdf_view.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,6 @@ <h2>{{ display_name }}</h2>
</object>
{% if not disable_all_download %}
<ul>
{% if allow_download %}
<li class="pdf-download-button">
<a href="{{ url }}" download>{% trans "Download the PDF" %}</a>
</li>
{% endif %}
{% if source_url != "" %}
<li class="pdf-download-button">
<a href="{{ source_url }}" download>{% if source_text == "" %}{% trans "Download the source document" %}{% else %}{{ source_text }}{% endif %}</a>
Expand Down
Loading