1
=== modified file '.bzrignore'
2
--- .bzrignore	2018-09-07 06:43:01 +0000
3
+++ .bzrignore	2019-07-01 17:47:01 +0000
4
@@ -1,55 +1,48 @@
5
1
*.*~
1
*.*~
6
2
*.~\?~
7
3
\#*\#
8
4
build
9
5
.cache
10
6
cover
11
7
.coverage
12
8
coverage
13
9
.directory
14
10
dist
15
11
*.dll
2
*.dll
16
12
documentation/build/doctrees
17
13
documentation/build/html
18
14
*.e4*
3
*.e4*
19
15
*eric[1-9]project
20
16
.git
21
17
# Git files
22
18
.gitignore
23
19
htmlcov
24
20
.idea
25
21
*.kate-swp
4
*.kate-swp
26
22
*.kdev4
5
*.kdev4
27
23
.kdev4
28
24
*.komodoproject
6
*.komodoproject
29
25
.komodotools
30
26
list
31
27
*.log*
7
*.log*
32
28
*.nja
8
*.nja
33
29
openlp.cfg
34
30
openlp/core/resources.py.old
35
31
OpenLP.egg-info
36
32
openlp.org 2.0.e4*
37
33
openlp.pro
38
34
openlp-test-projectordb.sqlite
39
35
*.orig
9
*.orig
40
36
output
41
37
*.pyc
10
*.pyc
42
38
__pycache__
43
39
.pylint.d
44
40
.pytest_cache
45
41
*.qm
11
*.qm
46
42
*.rej
12
*.rej
47
43
# Rejected diff's
48
44
resources/innosetup/Output
49
45
resources/windows/warnOpenLP.txt
50
46
*.ropeproject
13
*.ropeproject
53
47
tags
14
*.~\?~
54
48
output
15
*eric[1-9]project
55
16
.cache
56
17
.coverage
57
18
.directory
58
19
.git
59
20
.gitignore
60
21
.idea
61
22
.kdev4
62
23
.komodotools
63
24
.pylint.d
64
25
.pytest_cache
65
26
.vscode
66
27
OpenLP.egg-info
67
28
\#*\#
68
29
__pycache__
69
30
build
70
31
cover
71
32
coverage
72
33
dist
73
34
env
74
49
htmlcov
35
htmlcov
75
36
list
76
50
node_modules
37
node_modules
77
51
openlp-test-projectordb.sqlite
38
openlp-test-projectordb.sqlite
78
39
openlp.cfg
79
40
openlp.pro
80
41
openlp/core/resources.py.old
81
42
openlp/plugins/presentations/lib/vendor/Pyro4
82
43
openlp/plugins/presentations/lib/vendor/serpent.py
83
44
output
84
52
package-lock.json
45
package-lock.json
86
53
.cache
46
tags
87
54
test
47
test
88
55
tests.kdev4
48
tests.kdev4
89
56
49
90
=== modified file 'LICENSE'
91
--- LICENSE	2011-02-24 05:47:38 +0000
92
+++ LICENSE	2019-07-01 17:47:01 +0000
93
@@ -1,285 +1,626 @@
96
1
            GNU GENERAL PUBLIC LICENSE
1
                    GNU GENERAL PUBLIC LICENSE
97
2
               Version 2, June 1991
2
                       Version 3, 29 June 2007
98
3
3
101
4
 Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
4
 Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
100
5
 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
102
6
 Everyone is permitted to copy and distribute verbatim copies
5
 Everyone is permitted to copy and distribute verbatim copies
103
7
 of this license document, but changing it is not allowed.
6
 of this license document, but changing it is not allowed.
104
8
7
115
9
                Preamble
8
                            Preamble
116
10
9
117
11
  The licenses for most software are designed to take away your
10
  The GNU General Public License is a free, copyleft license for
118
12
freedom to share and change it.  By contrast, the GNU General Public
11
software and other kinds of works.
119
13
License is intended to guarantee your freedom to share and change free
12
120
14
software--to make sure the software is free for all its users.  This
13
  The licenses for most software and other practical works are designed
121
15
General Public License applies to most of the Free Software
14
to take away your freedom to share and change the works.  By contrast,
122
16
Foundation's software and to any other program whose authors commit to
15
the GNU General Public License is intended to guarantee your freedom to
123
17
using it.  (Some other Free Software Foundation software is covered by
16
share and change all versions of a program--to make sure it remains free
124
18
the GNU Lesser General Public License instead.)  You can apply it to
17
software for all its users.  We, the Free Software Foundation, use the
125
18
GNU General Public License for most of our software; it applies also to
126
19
any other work released this way by its authors.  You can apply it to
127
19
your programs, too.
20
your programs, too.
128
20
21
129
21
  When we speak of free software, we are referring to freedom, not
22
  When we speak of free software, we are referring to freedom, not
130
22
price.  Our General Public Licenses are designed to make sure that you
23
price.  Our General Public Licenses are designed to make sure that you
131
23
have the freedom to distribute copies of free software (and charge for
24
have the freedom to distribute copies of free software (and charge for
135
24
this service if you wish), that you receive source code or can get it
25
them if you wish), that you receive source code or can get it if you
136
25
if you want it, that you can change the software or use pieces of it
26
want it, that you can change the software or use pieces of it in new
137
26
in new free programs; and that you know you can do these things.
27
free programs, and that you know you can do these things.
138
27
28
143
28
  To protect your rights, we need to make restrictions that forbid
29
  To protect your rights, we need to prevent others from denying you
144
29
anyone to deny you these rights or to ask you to surrender the rights.
30
these rights or asking you to surrender the rights.  Therefore, you have
145
30
These restrictions translate to certain responsibilities for you if you
31
certain responsibilities if you distribute copies of the software, or if
146
31
distribute copies of the software, or if you modify it.
32
you modify it: responsibilities to respect the freedom of others.
147
32
33
148
33
  For example, if you distribute copies of such a program, whether
34
  For example, if you distribute copies of such a program, whether
170
34
gratis or for a fee, you must give the recipients all the rights that
35
gratis or for a fee, you must pass on to the recipients the same
171
35
you have.  You must make sure that they, too, receive or can get the
36
freedoms that you received.  You must make sure that they, too, receive
172
36
source code.  And you must show them these terms so they know their
37
or can get the source code.  And you must show them these terms so they
173
37
rights.
38
know their rights.
174
38
39
175
39
  We protect your rights with two steps: (1) copyright the software, and
40
  Developers that use the GNU GPL protect your rights with two steps:
176
40
(2) offer you this license which gives you legal permission to copy,
41
(1) assert copyright on the software, and (2) offer you this License
177
41
distribute and/or modify the software.
42
giving you legal permission to copy, distribute and/or modify it.
178
42
43
179
43
  Also, for each author's protection and ours, we want to make certain
44
  For the developers' and authors' protection, the GPL clearly explains
180
44
that everyone understands that there is no warranty for this free
45
that there is no warranty for this free software.  For both users' and
181
45
software.  If the software is modified by someone else and passed on, we
46
authors' sake, the GPL requires that modified versions be marked as
182
46
want its recipients to know that what they have is not the original, so
47
changed, so that their problems will not be attributed erroneously to
183
47
that any problems introduced by others will not reflect on the original
48
authors of previous versions.
184
48
authors' reputations.
49
185
49
50
  Some devices are designed to deny users access to install or run
186
50
  Finally, any free program is threatened constantly by software
51
modified versions of the software inside them, although the manufacturer
187
51
patents.  We wish to avoid the danger that redistributors of a free
52
can do so.  This is fundamentally incompatible with the aim of
188
52
program will individually obtain patent licenses, in effect making the
53
protecting users' freedom to change the software.  The systematic
189
53
program proprietary.  To prevent this, we have made it clear that any
54
pattern of such abuse occurs in the area of products for individuals to
190
54
patent must be licensed for everyone's free use or not licensed at all.
55
use, which is precisely where it is most unacceptable.  Therefore, we
191
56
have designed this version of the GPL to prohibit the practice for those
192
57
products.  If such problems arise substantially in other domains, we
193
58
stand ready to extend this provision to those domains in future versions
194
59
of the GPL, as needed to protect the freedom of users.
195
60
196
61
  Finally, every program is threatened constantly by software patents.
197
62
States should not allow patents to restrict development and use of
198
63
software on general-purpose computers, but in those that do, we wish to
199
64
avoid the special danger that patents applied to a free program could
200
65
make it effectively proprietary.  To prevent this, the GPL assures that
201
66
patents cannot be used to render the program non-free.
202
55
67
203
56
  The precise terms and conditions for copying, distribution and
68
  The precise terms and conditions for copying, distribution and
204
57
modification follow.
69
modification follow.
205
58
70
342
59
            GNU GENERAL PUBLIC LICENSE
71
                       TERMS AND CONDITIONS
343
60
   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
72
344
61
73
  0. Definitions.
345
62
  0. This License applies to any program or other work which contains
74
346
63
a notice placed by the copyright holder saying it may be distributed
75
  "This License" refers to version 3 of the GNU General Public License.
347
64
under the terms of this General Public License.  The "Program", below,
76
348
65
refers to any such program or work, and a "work based on the Program"
77
  "Copyright" also means copyright-like laws that apply to other kinds of
349
66
means either the Program or any derivative work under copyright law:
78
works, such as semiconductor masks.
350
67
that is to say, a work containing the Program or a portion of it,
79
351
68
either verbatim or with modifications and/or translated into another
80
  "The Program" refers to any copyrightable work licensed under this
352
69
language.  (Hereinafter, translation is included without limitation in
81
License.  Each licensee is addressed as "you".  "Licensees" and
353
70
the term "modification".)  Each licensee is addressed as "you".
82
"recipients" may be individuals or organizations.
354
71
83
355
72
Activities other than copying, distribution and modification are not
84
  To "modify" a work means to copy from or adapt all or part of the work
356
73
covered by this License; they are outside its scope.  The act of
85
in a fashion requiring copyright permission, other than the making of an
357
74
running the Program is not restricted, and the output from the Program
86
exact copy.  The resulting work is called a "modified version" of the
358
75
is covered only if its contents constitute a work based on the
87
earlier work or a work "based on" the earlier work.
359
76
Program (independent of having been made by running the Program).
88
360
77
Whether that is true depends on what the Program does.
89
  A "covered work" means either the unmodified Program or a work based
361
78
90
on the Program.
362
79
  1. You may copy and distribute verbatim copies of the Program's
91
363
80
source code as you receive it, in any medium, provided that you
92
  To "propagate" a work means to do anything with it that, without
364
81
conspicuously and appropriately publish on each copy an appropriate
93
permission, would make you directly or secondarily liable for
365
82
copyright notice and disclaimer of warranty; keep intact all the
94
infringement under applicable copyright law, except executing it on a
366
83
notices that refer to this License and to the absence of any warranty;
95
computer or modifying a private copy.  Propagation includes copying,
367
84
and give any other recipients of the Program a copy of this License
96
distribution (with or without modification), making available to the
368
85
along with the Program.
97
public, and in some countries other activities as well.
369
86
98
370
87
You may charge a fee for the physical act of transferring a copy, and
99
  To "convey" a work means any kind of propagation that enables other
371
88
you may at your option offer warranty protection in exchange for a fee.
100
parties to make or receive copies.  Mere interaction with a user through
372
89
101
a computer network, with no transfer of a copy, is not conveying.
373
90
  2. You may modify your copy or copies of the Program or any portion
102
374
91
of it, thus forming a work based on the Program, and copy and
103
  An interactive user interface displays "Appropriate Legal Notices"
375
92
distribute such modifications or work under the terms of Section 1
104
to the extent that it includes a convenient and prominently visible
376
93
above, provided that you also meet all of these conditions:
105
feature that (1) displays an appropriate copyright notice, and (2)
377
94
106
tells the user that there is no warranty for the work (except to the
378
95
    a) You must cause the modified files to carry prominent notices
107
extent that warranties are provided), that licensees may convey the
379
96
    stating that you changed the files and the date of any change.
108
work under this License, and how to view a copy of this License.  If
380
97
109
the interface presents a list of user commands or options, such as a
381
98
    b) You must cause any work that you distribute or publish, that in
110
menu, a prominent item in the list meets this criterion.
382
99
    whole or in part contains or is derived from the Program or any
111
383
100
    part thereof, to be licensed as a whole at no charge to all third
112
  1. Source Code.
384
101
    parties under the terms of this License.
113
385
102
114
  The "source code" for a work means the preferred form of the work
386
103
    c) If the modified program normally reads commands interactively
115
for making modifications to it.  "Object code" means any non-source
387
104
    when run, you must cause it, when started running for such
116
form of a work.
388
105
    interactive use in the most ordinary way, to print or display an
117
389
106
    announcement including an appropriate copyright notice and a
118
  A "Standard Interface" means an interface that either is an official
390
107
    notice that there is no warranty (or else, saying that you provide
119
standard defined by a recognized standards body, or, in the case of
391
108
    a warranty) and that users may redistribute the program under
120
interfaces specified for a particular programming language, one that
392
109
    these conditions, and telling the user how to view a copy of this
121
is widely used among developers working in that language.
393
110
    License.  (Exception: if the Program itself is interactive but
122
394
111
    does not normally print such an announcement, your work based on
123
  The "System Libraries" of an executable work include anything, other
395
112
    the Program is not required to print an announcement.)
124
than the work as a whole, that (a) is included in the normal form of
396
113
125
packaging a Major Component, but which is not part of that Major
397
114
These requirements apply to the modified work as a whole.  If
126
Component, and (b) serves only to enable use of the work with that
398
115
identifiable sections of that work are not derived from the Program,
127
Major Component, or to implement a Standard Interface for which an
399
116
and can be reasonably considered independent and separate works in
128
implementation is available to the public in source code form.  A
400
117
themselves, then this License, and its terms, do not apply to those
129
"Major Component", in this context, means a major essential component
401
118
sections when you distribute them as separate works.  But when you
130
(kernel, window system, and so on) of the specific operating system
402
119
distribute the same sections as part of a whole which is a work based
131
(if any) on which the executable work runs, or a compiler used to
403
120
on the Program, the distribution of the whole must be on the terms of
132
produce the work, or an object code interpreter used to run it.
404
121
this License, whose permissions for other licensees extend to the
133
405
122
entire whole, and thus to each and every part regardless of who wrote it.
134
  The "Corresponding Source" for a work in object code form means all
406
123
135
the source code needed to generate, install, and (for an executable
407
124
Thus, it is not the intent of this section to claim rights or contest
136
work) run the object code and to modify the work, including scripts to
408
125
your rights to work written entirely by you; rather, the intent is to
137
control those activities.  However, it does not include the work's
409
126
exercise the right to control the distribution of derivative or
138
System Libraries, or general-purpose tools or generally available free
410
127
collective works based on the Program.
139
programs which are used unmodified in performing those activities but
411
128
140
which are not part of the work.  For example, Corresponding Source
412
129
In addition, mere aggregation of another work not based on the Program
141
includes interface definition files associated with source files for
413
130
with the Program (or with a work based on the Program) on a volume of
142
the work, and the source code for shared libraries and dynamically
414
131
a storage or distribution medium does not bring the other work under
143
linked subprograms that the work is specifically designed to require,
415
132
the scope of this License.
144
such as by intimate data communication or control flow between those
416
133
145
subprograms and other parts of the work.
417
134
  3. You may copy and distribute the Program (or a work based on it,
146
418
135
under Section 2) in object code or executable form under the terms of
147
  The Corresponding Source need not include anything that users
419
136
Sections 1 and 2 above provided that you also do one of the following:
148
can regenerate automatically from other parts of the Corresponding
420
137
149
Source.
421
138
    a) Accompany it with the complete corresponding machine-readable
150
422
139
    source code, which must be distributed under the terms of Sections
151
  The Corresponding Source for a work in source code form is that
423
140
    1 and 2 above on a medium customarily used for software interchange; or,
152
same work.
424
141
153
425
142
    b) Accompany it with a written offer, valid for at least three
154
  2. Basic Permissions.
426
143
    years, to give any third party, for a charge no more than your
155
427
144
    cost of physically performing source distribution, a complete
156
  All rights granted under this License are granted for the term of
428
145
    machine-readable copy of the corresponding source code, to be
157
copyright on the Program, and are irrevocable provided the stated
429
146
    distributed under the terms of Sections 1 and 2 above on a medium
158
conditions are met.  This License explicitly affirms your unlimited
430
147
    customarily used for software interchange; or,
159
permission to run the unmodified Program.  The output from running a
431
148
160
covered work is covered by this License only if the output, given its
432
149
    c) Accompany it with the information you received as to the offer
161
content, constitutes a covered work.  This License acknowledges your
433
150
    to distribute corresponding source code.  (This alternative is
162
rights of fair use or other equivalent, as provided by copyright law.
434
151
    allowed only for noncommercial distribution and only if you
163
435
152
    received the program in object code or executable form with such
164
  You may make, run and propagate covered works that you do not
436
153
    an offer, in accord with Subsection b above.)
165
convey, without conditions so long as your license otherwise remains
437
154
166
in force.  You may convey covered works to others for the sole purpose
438
155
The source code for a work means the preferred form of the work for
167
of having them make modifications exclusively for you, or provide you
439
156
making modifications to it.  For an executable work, complete source
168
with facilities for running those works, provided that you comply with
440
157
code means all the source code for all modules it contains, plus any
169
the terms of this License in conveying all material for which you do
441
158
associated interface definition files, plus the scripts used to
170
not control copyright.  Those thus making or running the covered works
442
159
control compilation and installation of the executable.  However, as a
171
for you must do so exclusively on your behalf, under your direction
443
160
special exception, the source code distributed need not include
172
and control, on terms that prohibit them from making any copies of
444
161
anything that is normally distributed (in either source or binary
173
your copyrighted material outside their relationship with you.
445
162
form) with the major components (compiler, kernel, and so on) of the
174
446
163
operating system on which the executable runs, unless that component
175
  Conveying under any other circumstances is permitted solely under
447
164
itself accompanies the executable.
176
the conditions stated below.  Sublicensing is not allowed; section 10
448
165
177
makes it unnecessary.
449
166
If distribution of executable or object code is made by offering
178
450
167
access to copy from a designated place, then offering equivalent
179
  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
451
168
access to copy the source code from the same place counts as
180
452
169
distribution of the source code, even though third parties are not
181
  No covered work shall be deemed part of an effective technological
453
170
compelled to copy the source along with the object code.
182
measure under any applicable law fulfilling obligations under article
454
171
183
11 of the WIPO copyright treaty adopted on 20 December 1996, or
455
172
  4. You may not copy, modify, sublicense, or distribute the Program
184
similar laws prohibiting or restricting circumvention of such
456
173
except as expressly provided under this License.  Any attempt
185
measures.
457
174
otherwise to copy, modify, sublicense or distribute the Program is
186
458
175
void, and will automatically terminate your rights under this License.
187
  When you convey a covered work, you waive any legal power to forbid
459
176
However, parties who have received copies, or rights, from you under
188
circumvention of technological measures to the extent such circumvention
460
177
this License will not have their licenses terminated so long as such
189
is effected by exercising rights under this License with respect to
461
178
parties remain in full compliance.
190
the covered work, and you disclaim any intention to limit operation or
462
179
191
modification of the work as a means of enforcing, against the work's
463
180
  5. You are not required to accept this License, since you have not
192
users, your or third parties' legal rights to forbid circumvention of
464
181
signed it.  However, nothing else grants you permission to modify or
193
technological measures.
465
182
distribute the Program or its derivative works.  These actions are
194
466
183
prohibited by law if you do not accept this License.  Therefore, by
195
  4. Conveying Verbatim Copies.
467
184
modifying or distributing the Program (or any work based on the
196
468
185
Program), you indicate your acceptance of this License to do so, and
197
  You may convey verbatim copies of the Program's source code as you
469
186
all its terms and conditions for copying, distributing or modifying
198
receive it, in any medium, provided that you conspicuously and
470
187
the Program or works based on it.
199
appropriately publish on each copy an appropriate copyright notice;
471
188
200
keep intact all notices stating that this License and any
472
189
  6. Each time you redistribute the Program (or any work based on the
201
non-permissive terms added in accord with section 7 apply to the code;
473
190
Program), the recipient automatically receives a license from the
202
keep intact all notices of the absence of any warranty; and give all
474
191
original licensor to copy, distribute or modify the Program subject to
203
recipients a copy of this License along with the Program.
475
192
these terms and conditions.  You may not impose any further
204
476
193
restrictions on the recipients' exercise of the rights granted herein.
205
  You may charge any price or no price for each copy that you convey,
477
194
You are not responsible for enforcing compliance by third parties to
206
and you may offer support or warranty protection for a fee.
478
207
479
208
  5. Conveying Modified Source Versions.
480
209
481
210
  You may convey a work based on the Program, or the modifications to
482
211
produce it from the Program, in the form of source code under the
483
212
terms of section 4, provided that you also meet all of these conditions:
484
213
485
214
    a) The work must carry prominent notices stating that you modified
486
215
    it, and giving a relevant date.
487
216
488
217
    b) The work must carry prominent notices stating that it is
489
218
    released under this License and any conditions added under section
490
219
    7.  This requirement modifies the requirement in section 4 to
491
220
    "keep intact all notices".
492
221
493
222
    c) You must license the entire work, as a whole, under this
494
223
    License to anyone who comes into possession of a copy.  This
495
224
    License will therefore apply, along with any applicable section 7
496
225
    additional terms, to the whole of the work, and all its parts,
497
226
    regardless of how they are packaged.  This License gives no
498
227
    permission to license the work in any other way, but it does not
499
228
    invalidate such permission if you have separately received it.
500
229
501
230
    d) If the work has interactive user interfaces, each must display
502
231
    Appropriate Legal Notices; however, if the Program has interactive
503
232
    interfaces that do not display Appropriate Legal Notices, your
504
233
    work need not make them do so.
505
234
506
235
  A compilation of a covered work with other separate and independent
507
236
works, which are not by their nature extensions of the covered work,
508
237
and which are not combined with it such as to form a larger program,
509
238
in or on a volume of a storage or distribution medium, is called an
510
239
"aggregate" if the compilation and its resulting copyright are not
511
240
used to limit the access or legal rights of the compilation's users
512
241
beyond what the individual works permit.  Inclusion of a covered work
513
242
in an aggregate does not cause this License to apply to the other
514
243
parts of the aggregate.
515
244
516
245
  6. Conveying Non-Source Forms.
517
246
518
247
  You may convey a covered work in object code form under the terms
519
248
of sections 4 and 5, provided that you also convey the
520
249
machine-readable Corresponding Source under the terms of this License,
521
250
in one of these ways:
522
251
523
252
    a) Convey the object code in, or embodied in, a physical product
524
253
    (including a physical distribution medium), accompanied by the
525
254
    Corresponding Source fixed on a durable physical medium
526
255
    customarily used for software interchange.
527
256
528
257
    b) Convey the object code in, or embodied in, a physical product
529
258
    (including a physical distribution medium), accompanied by a
530
259
    written offer, valid for at least three years and valid for as
531
260
    long as you offer spare parts or customer support for that product
532
261
    model, to give anyone who possesses the object code either (1) a
533
262
    copy of the Corresponding Source for all the software in the
534
263
    product that is covered by this License, on a durable physical
535
264
    medium customarily used for software interchange, for a price no
536
265
    more than your reasonable cost of physically performing this
537
266
    conveying of source, or (2) access to copy the
538
267
    Corresponding Source from a network server at no charge.
539
268
540
269
    c) Convey individual copies of the object code with a copy of the
541
270
    written offer to provide the Corresponding Source.  This
542
271
    alternative is allowed only occasionally and noncommercially, and
543
272
    only if you received the object code with such an offer, in accord
544
273
    with subsection 6b.
545
274
546
275
    d) Convey the object code by offering access from a designated
547
276
    place (gratis or for a charge), and offer equivalent access to the
548
277
    Corresponding Source in the same way through the same place at no
549
278
    further charge.  You need not require recipients to copy the
550
279
    Corresponding Source along with the object code.  If the place to
551
280
    copy the object code is a network server, the Corresponding Source
552
281
    may be on a different server (operated by you or a third party)
553
282
    that supports equivalent copying facilities, provided you maintain
554
283
    clear directions next to the object code saying where to find the
555
284
    Corresponding Source.  Regardless of what server hosts the
556
285
    Corresponding Source, you remain obligated to ensure that it is
557
286
    available for as long as needed to satisfy these requirements.
558
287
559
288
    e) Convey the object code using peer-to-peer transmission, provided
560
289
    you inform other peers where the object code and Corresponding
561
290
    Source of the work are being offered to the general public at no
562
291
    charge under subsection 6d.
563
292
564
293
  A separable portion of the object code, whose source code is excluded
565
294
from the Corresponding Source as a System Library, need not be
566
295
included in conveying the object code work.
567
296
568
297
  A "User Product" is either (1) a "consumer product", which means any
569
298
tangible personal property which is normally used for personal, family,
570
299
or household purposes, or (2) anything designed or sold for incorporation
571
300
into a dwelling.  In determining whether a product is a consumer product,
572
301
doubtful cases shall be resolved in favor of coverage.  For a particular
573
302
product received by a particular user, "normally used" refers to a
574
303
typical or common use of that class of product, regardless of the status
575
304
of the particular user or of the way in which the particular user
576
305
actually uses, or expects or is expected to use, the product.  A product
577
306
is a consumer product regardless of whether the product has substantial
578
307
commercial, industrial or non-consumer uses, unless such uses represent
579
308
the only significant mode of use of the product.
580
309
581
310
  "Installation Information" for a User Product means any methods,
582
311
procedures, authorization keys, or other information required to install
583
312
and execute modified versions of a covered work in that User Product from
584
313
a modified version of its Corresponding Source.  The information must
585
314
suffice to ensure that the continued functioning of the modified object
586
315
code is in no case prevented or interfered with solely because
587
316
modification has been made.
588
317
589
318
  If you convey an object code work under this section in, or with, or
590
319
specifically for use in, a User Product, and the conveying occurs as
591
320
part of a transaction in which the right of possession and use of the
592
321
User Product is transferred to the recipient in perpetuity or for a
593
322
fixed term (regardless of how the transaction is characterized), the
594
323
Corresponding Source conveyed under this section must be accompanied
595
324
by the Installation Information.  But this requirement does not apply
596
325
if neither you nor any third party retains the ability to install
597
326
modified object code on the User Product (for example, the work has
598
327
been installed in ROM).
599
328
600
329
  The requirement to provide Installation Information does not include a
601
330
requirement to continue to provide support service, warranty, or updates
602
331
for a work that has been modified or installed by the recipient, or for
603
332
the User Product in which it has been modified or installed.  Access to a
604
333
network may be denied when the modification itself materially and
605
334
adversely affects the operation of the network or violates the rules and
606
335
protocols for communication across the network.
607
336
608
337
  Corresponding Source conveyed, and Installation Information provided,
609
338
in accord with this section must be in a format that is publicly
610
339
documented (and with an implementation available to the public in
611
340
source code form), and must require no special password or key for
612
341
unpacking, reading or copying.
613
342
614
343
  7. Additional Terms.
615
344
616
345
  "Additional permissions" are terms that supplement the terms of this
617
346
License by making exceptions from one or more of its conditions.
618
347
Additional permissions that are applicable to the entire Program shall
619
348
be treated as though they were included in this License, to the extent
620
349
that they are valid under applicable law.  If additional permissions
621
350
apply only to part of the Program, that part may be used separately
622
351
under those permissions, but the entire Program remains governed by
623
352
this License without regard to the additional permissions.
624
353
625
354
  When you convey a copy of a covered work, you may at your option
626
355
remove any additional permissions from that copy, or from any part of
627
356
it.  (Additional permissions may be written to require their own
628
357
removal in certain cases when you modify the work.)  You may place
629
358
additional permissions on material, added by you to a covered work,
630
359
for which you have or can give appropriate copyright permission.
631
360
632
361
  Notwithstanding any other provision of this License, for material you
633
362
add to a covered work, you may (if authorized by the copyright holders of
634
363
that material) supplement the terms of this License with terms:
635
364
636
365
    a) Disclaiming warranty or limiting liability differently from the
637
366
    terms of sections 15 and 16 of this License; or
638
367
639
368
    b) Requiring preservation of specified reasonable legal notices or
640
369
    author attributions in that material or in the Appropriate Legal
641
370
    Notices displayed by works containing it; or
642
371
643
372
    c) Prohibiting misrepresentation of the origin of that material, or
644
373
    requiring that modified versions of such material be marked in
645
374
    reasonable ways as different from the original version; or
646
375
647
376
    d) Limiting the use for publicity purposes of names of licensors or
648
377
    authors of the material; or
649
378
650
379
    e) Declining to grant rights under trademark law for use of some
651
380
    trade names, trademarks, or service marks; or
652
381
653
382
    f) Requiring indemnification of licensors and authors of that
654
383
    material by anyone who conveys the material (or modified versions of
655
384
    it) with contractual assumptions of liability to the recipient, for
656
385
    any liability that these contractual assumptions directly impose on
657
386
    those licensors and authors.
658
387
659
388
  All other non-permissive additional terms are considered "further
660
389
restrictions" within the meaning of section 10.  If the Program as you
661
390
received it, or any part of it, contains a notice stating that it is
662
391
governed by this License along with a term that is a further
663
392
restriction, you may remove that term.  If a license document contains
664
393
a further restriction but permits relicensing or conveying under this
665
394
License, you may add to a covered work material governed by the terms
666
395
of that license document, provided that the further restriction does
667
396
not survive such relicensing or conveying.
668
397
669
398
  If you add terms to a covered work in accord with this section, you
670
399
must place, in the relevant source files, a statement of the
671
400
additional terms that apply to those files, or a notice indicating
672
401
where to find the applicable terms.
673
402
674
403
  Additional terms, permissive or non-permissive, may be stated in the
675
404
form of a separately written license, or stated as exceptions;
676
405
the above requirements apply either way.
677
406
678
407
  8. Termination.
679
408
680
409
  You may not propagate or modify a covered work except as expressly
681
410
provided under this License.  Any attempt otherwise to propagate or
682
411
modify it is void, and will automatically terminate your rights under
683
412
this License (including any patent licenses granted under the third
684
413
paragraph of section 11).
685
414
686
415
  However, if you cease all violation of this License, then your
687
416
license from a particular copyright holder is reinstated (a)
688
417
provisionally, unless and until the copyright holder explicitly and
689
418
finally terminates your license, and (b) permanently, if the copyright
690
419
holder fails to notify you of the violation by some reasonable means
691
420
prior to 60 days after the cessation.
692
421
693
422
  Moreover, your license from a particular copyright holder is
694
423
reinstated permanently if the copyright holder notifies you of the
695
424
violation by some reasonable means, this is the first time you have
696
425
received notice of violation of this License (for any work) from that
697
426
copyright holder, and you cure the violation prior to 30 days after
698
427
your receipt of the notice.
699
428
700
429
  Termination of your rights under this section does not terminate the
701
430
licenses of parties who have received copies or rights from you under
702
431
this License.  If your rights have been terminated and not permanently
703
432
reinstated, you do not qualify to receive new licenses for the same
704
433
material under section 10.
705
434
706
435
  9. Acceptance Not Required for Having Copies.
707
436
708
437
  You are not required to accept this License in order to receive or
709
438
run a copy of the Program.  Ancillary propagation of a covered work
710
439
occurring solely as a consequence of using peer-to-peer transmission
711
440
to receive a copy likewise does not require acceptance.  However,
712
441
nothing other than this License grants you permission to propagate or
713
442
modify any covered work.  These actions infringe copyright if you do
714
443
not accept this License.  Therefore, by modifying or propagating a
715
444
covered work, you indicate your acceptance of this License to do so.
716
445
717
446
  10. Automatic Licensing of Downstream Recipients.
718
447
719
448
  Each time you convey a covered work, the recipient automatically
720
449
receives a license from the original licensors, to run, modify and
721
450
propagate that work, subject to this License.  You are not responsible
722
451
for enforcing compliance by third parties with this License.
723
452
724
453
  An "entity transaction" is a transaction transferring control of an
725
454
organization, or substantially all assets of one, or subdividing an
726
455
organization, or merging organizations.  If propagation of a covered
727
456
work results from an entity transaction, each party to that
728
457
transaction who receives a copy of the work also receives whatever
729
458
licenses to the work the party's predecessor in interest had or could
730
459
give under the previous paragraph, plus a right to possession of the
731
460
Corresponding Source of the work from the predecessor in interest, if
732
461
the predecessor has it or can get it with reasonable efforts.
733
462
734
463
  You may not impose any further restrictions on the exercise of the
735
464
rights granted or affirmed under this License.  For example, you may
736
465
not impose a license fee, royalty, or other charge for exercise of
737
466
rights granted under this License, and you may not initiate litigation
738
467
(including a cross-claim or counterclaim in a lawsuit) alleging that
739
468
any patent claim is infringed by making, using, selling, offering for
740
469
sale, or importing the Program or any portion of it.
741
470
742
471
  11. Patents.
743
472
744
473
  A "contributor" is a copyright holder who authorizes use under this
745
474
License of the Program or a work on which the Program is based.  The
746
475
work thus licensed is called the contributor's "contributor version".
747
476
748
477
  A contributor's "essential patent claims" are all patent claims
749
478
owned or controlled by the contributor, whether already acquired or
750
479
hereafter acquired, that would be infringed by some manner, permitted
751
480
by this License, of making, using, or selling its contributor version,
752
481
but do not include claims that would be infringed only as a
753
482
consequence of further modification of the contributor version.  For
754
483
purposes of this definition, "control" includes the right to grant
755
484
patent sublicenses in a manner consistent with the requirements of
756
195
this License.
485
this License.
757
196
486
761
197
  7. If, as a consequence of a court judgment or allegation of patent
487
  Each contributor grants you a non-exclusive, worldwide, royalty-free
762
198
infringement or for any other reason (not limited to patent issues),
488
patent license under the contributor's essential patent claims, to
763
199
conditions are imposed on you (whether by court order, agreement or
489
make, use, sell, offer for sale, import and otherwise run, modify and
764
490
propagate the contents of its contributor version.
765
491
766
492
  In the following three paragraphs, a "patent license" is any express
767
493
agreement or commitment, however denominated, not to enforce a patent
768
494
(such as an express permission to practice a patent or covenant not to
769
495
sue for patent infringement).  To "grant" such a patent license to a
770
496
party means to make such an agreement or commitment not to enforce a
771
497
patent against the party.
772
498
773
499
  If you convey a covered work, knowingly relying on a patent license,
774
500
and the Corresponding Source of the work is not available for anyone
775
501
to copy, free of charge and under the terms of this License, through a
776
502
publicly available network server or other readily accessible means,
777
503
then you must either (1) cause the Corresponding Source to be so
778
504
available, or (2) arrange to deprive yourself of the benefit of the
779
505
patent license for this particular work, or (3) arrange, in a manner
780
506
consistent with the requirements of this License, to extend the patent
781
507
license to downstream recipients.  "Knowingly relying" means you have
782
508
actual knowledge that, but for the patent license, your conveying the
783
509
covered work in a country, or your recipient's use of the covered work
784
510
in a country, would infringe one or more identifiable patents in that
785
511
country that you have reason to believe are valid.
786
512
787
513
  If, pursuant to or in connection with a single transaction or
788
514
arrangement, you convey, or propagate by procuring conveyance of, a
789
515
covered work, and grant a patent license to some of the parties
790
516
receiving the covered work authorizing them to use, propagate, modify
791
517
or convey a specific copy of the covered work, then the patent license
792
518
you grant is automatically extended to all recipients of the covered
793
519
work and works based on it.
794
520
795
521
  A patent license is "discriminatory" if it does not include within
796
522
the scope of its coverage, prohibits the exercise of, or is
797
523
conditioned on the non-exercise of one or more of the rights that are
798
524
specifically granted under this License.  You may not convey a covered
799
525
work if you are a party to an arrangement with a third party that is
800
526
in the business of distributing software, under which you make payment
801
527
to the third party based on the extent of your activity of conveying
802
528
the work, and under which the third party grants, to any of the
803
529
parties who would receive the covered work from you, a discriminatory
804
530
patent license (a) in connection with copies of the covered work
805
531
conveyed by you (or copies made from those copies), or (b) primarily
806
532
for and in connection with specific products or compilations that
807
533
contain the covered work, unless you entered into that arrangement,
808
534
or that patent license was granted, prior to 28 March 2007.
809
535
810
536
  Nothing in this License shall be construed as excluding or limiting
811
537
any implied license or other defenses to infringement that may
812
538
otherwise be available to you under applicable patent law.
813
539
814
540
  12. No Surrender of Others' Freedom.
815
541
816
542
  If conditions are imposed on you (whether by court order, agreement or
817
200
otherwise) that contradict the conditions of this License, they do not
543
otherwise) that contradict the conditions of this License, they do not
856
201
excuse you from the conditions of this License.  If you cannot
544
excuse you from the conditions of this License.  If you cannot convey a
857
202
distribute so as to satisfy simultaneously your obligations under this
545
covered work so as to satisfy simultaneously your obligations under this
858
203
License and any other pertinent obligations, then as a consequence you
546
License and any other pertinent obligations, then as a consequence you may
859
204
may not distribute the Program at all.  For example, if a patent
547
not convey it at all.  For example, if you agree to terms that obligate you
860
205
license would not permit royalty-free redistribution of the Program by
548
to collect a royalty for further conveying from those to whom you convey
861
206
all those who receive copies directly or indirectly through you, then
549
the Program, the only way you could satisfy both those terms and this
862
207
the only way you could satisfy both it and this License would be to
550
License would be to refrain entirely from conveying the Program.
863
208
refrain entirely from distribution of the Program.
551
864
209
552
  13. Use with the GNU Affero General Public License.
865
210
If any portion of this section is held invalid or unenforceable under
553
866
211
any particular circumstance, the balance of the section is intended to
554
  Notwithstanding any other provision of this License, you have
867
212
apply and the section as a whole is intended to apply in other
555
permission to link or combine any covered work with a work licensed
868
213
circumstances.
556
under version 3 of the GNU Affero General Public License into a single
869
214
557
combined work, and to convey the resulting work.  The terms of this
870
215
It is not the purpose of this section to induce you to infringe any
558
License will continue to apply to the part which is the covered work,
871
216
patents or other property right claims or to contest validity of any
559
but the special requirements of the GNU Affero General Public License,
872
217
such claims; this section has the sole purpose of protecting the
560
section 13, concerning interaction through a network will apply to the
873
218
integrity of the free software distribution system, which is
561
combination as such.
874
219
implemented by public license practices.  Many people have made
562
875
220
generous contributions to the wide range of software distributed
563
  14. Revised Versions of this License.
876
221
through that system in reliance on consistent application of that
564
877
222
system; it is up to the author/donor to decide if he or she is willing
565
  The Free Software Foundation may publish revised and/or new versions of
878
223
to distribute software through any other system and a licensee cannot
566
the GNU General Public License from time to time.  Such new versions will
841
224
impose that choice.
842
225
843
226
This section is intended to make thoroughly clear what is believed to
844
227
be a consequence of the rest of this License.
845
228
846
229
  8. If the distribution and/or use of the Program is restricted in
847
230
certain countries either by patents or by copyrighted interfaces, the
848
231
original copyright holder who places the Program under this License
849
232
may add an explicit geographical distribution limitation excluding
850
233
those countries, so that distribution is permitted only in or among
851
234
countries not thus excluded.  In such case, this License incorporates
852
235
the limitation as if written in the body of this License.
853
236
854
237
  9. The Free Software Foundation may publish revised and/or new versions
855
238
of the General Public License from time to time.  Such new versions will
879
239
be similar in spirit to the present version, but may differ in detail to
567
be similar in spirit to the present version, but may differ in detail to
880
240
address new problems or concerns.
568
address new problems or concerns.
881
241
569
923
242
Each version is given a distinguishing version number.  If the Program
570
  Each version is given a distinguishing version number.  If the
924
243
specifies a version number of this License which applies to it and "any
571
Program specifies that a certain numbered version of the GNU General
925
244
later version", you have the option of following the terms and conditions
572
Public License "or any later version" applies to it, you have the
926
245
either of that version or of any later version published by the Free
573
option of following the terms and conditions either of that numbered
927
246
Software Foundation.  If the Program does not specify a version number of
574
version or of any later version published by the Free Software
928
247
this License, you may choose any version ever published by the Free Software
575
Foundation.  If the Program does not specify a version number of the
929
248
Foundation.
576
GNU General Public License, you may choose any version ever published
930
249
577
by the Free Software Foundation.
931
250
  10. If you wish to incorporate parts of the Program into other free
578
932
251
programs whose distribution conditions are different, write to the author
579
  If the Program specifies that a proxy can decide which future
933
252
to ask for permission.  For software which is copyrighted by the Free
580
versions of the GNU General Public License can be used, that proxy's
934
253
Software Foundation, write to the Free Software Foundation; we sometimes
581
public statement of acceptance of a version permanently authorizes you
935
254
make exceptions for this.  Our decision will be guided by the two goals
582
to choose that version for the Program.
936
255
of preserving the free status of all derivatives of our free software and
583
937
256
of promoting the sharing and reuse of software generally.
584
  Later license versions may give you additional or different
938
257
585
permissions.  However, no additional obligations are imposed on any
939
258
                NO WARRANTY
586
author or copyright holder as a result of your choosing to follow a
940
259
587
later version.
941
260
  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
588
942
261
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
589
  15. Disclaimer of Warranty.
943
262
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
590
944
263
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
591
  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
945
264
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
592
APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
946
265
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
593
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
947
266
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
594
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
948
267
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
595
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
949
268
REPAIR OR CORRECTION.
596
PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
950
269
597
IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
951
270
  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
598
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
952
271
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
599
953
272
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
600
  16. Limitation of Liability.
954
273
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
601
955
274
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
602
  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
956
275
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
603
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
957
276
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
604
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
958
277
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
605
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
959
278
POSSIBILITY OF SUCH DAMAGES.
606
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
960
279
607
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
961
280
             END OF TERMS AND CONDITIONS
608
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
962
281
609
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
963
282
        How to Apply These Terms to Your New Programs
610
SUCH DAMAGES.
964
611
965
612
  17. Interpretation of Sections 15 and 16.
966
613
967
614
  If the disclaimer of warranty and limitation of liability provided
968
615
above cannot be given local legal effect according to their terms,
969
616
reviewing courts shall apply local law that most closely approximates
970
617
an absolute waiver of all civil liability in connection with the
971
618
Program, unless a warranty or assumption of liability accompanies a
972
619
copy of the Program in return for a fee.
973
620
974
621
                     END OF TERMS AND CONDITIONS
975
622
976
623
            How to Apply These Terms to Your New Programs
977
283
624
978
284
  If you develop a new program, and you want it to be of the greatest
625
  If you develop a new program, and you want it to be of the greatest
979
285
possible use to the public, the best way to achieve this is to make it
626
possible use to the public, the best way to achieve this is to make it
980
@@ -287,15 +628,15 @@
981
287
628
982
288
  To do so, attach the following notices to the program.  It is safest
629
  To do so, attach the following notices to the program.  It is safest
983
289
to attach them to the start of each source file to most effectively
630
to attach them to the start of each source file to most effectively
985
290
convey the exclusion of warranty; and each file should have at least
631
state the exclusion of warranty; and each file should have at least
986
291
the "copyright" line and a pointer to where the full notice is found.
632
the "copyright" line and a pointer to where the full notice is found.
987
292
633
988
293
    <one line to give the program's name and a brief idea of what it does.>
634
    <one line to give the program's name and a brief idea of what it does.>
989
294
    Copyright (C) <year>  <name of author>
635
    Copyright (C) <year>  <name of author>
990
295
636
992
296
    This program is free software; you can redistribute it and/or modify
637
    This program is free software: you can redistribute it and/or modify
993
297
    it under the terms of the GNU General Public License as published by
638
    it under the terms of the GNU General Public License as published by
995
298
    the Free Software Foundation; either version 2 of the License, or
639
    the Free Software Foundation, either version 3 of the License, or
996
299
    (at your option) any later version.
640
    (at your option) any later version.
997
300
641
998
301
    This program is distributed in the hope that it will be useful,
642
    This program is distributed in the hope that it will be useful,
999
@@ -303,37 +644,31 @@
1000
303
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
644
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
1001
304
    GNU General Public License for more details.
645
    GNU General Public License for more details.
1002
305
646
1006
306
    You should have received a copy of the GNU General Public License along
647
    You should have received a copy of the GNU General Public License
1007
307
    with this program; if not, write to the Free Software Foundation, Inc.,
648
    along with this program.  If not, see <https://www.gnu.org/licenses/>.
1005
308
    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
1008
309
649
1009
310
Also add information on how to contact you by electronic and paper mail.
650
Also add information on how to contact you by electronic and paper mail.
1010
311
651
1013
312
If the program is interactive, make it output a short notice like this
652
  If the program does terminal interaction, make it output a short
1014
313
when it starts in an interactive mode:
653
notice like this when it starts in an interactive mode:
1015
314
654
1018
315
    Gnomovision version 69, Copyright (C) year name of author
655
    <program>  Copyright (C) <year>  <name of author>
1019
316
    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
656
    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
1020
317
    This is free software, and you are welcome to redistribute it
657
    This is free software, and you are welcome to redistribute it
1021
318
    under certain conditions; type `show c' for details.
658
    under certain conditions; type `show c' for details.
1022
319
659
1023
320
The hypothetical commands `show w' and `show c' should show the appropriate
660
The hypothetical commands `show w' and `show c' should show the appropriate
1043
321
parts of the General Public License.  Of course, the commands you use may
661
parts of the General Public License.  Of course, your program's commands
1044
322
be called something other than `show w' and `show c'; they could even be
662
might be different; for a GUI interface, you would use an "about box".
1045
323
mouse-clicks or menu items--whatever suits your program.
663
1046
324
664
  You should also get your employer (if you work as a programmer) or school,
1047
325
You should also get your employer (if you work as a programmer) or your
665
if any, to sign a "copyright disclaimer" for the program, if necessary.
1048
326
school, if any, to sign a "copyright disclaimer" for the program, if
666
For more information on this, and how to apply and follow the GNU GPL, see
1049
327
necessary.  Here is a sample; alter the names:
667
<https://www.gnu.org/licenses/>.
1050
328
668
1051
329
  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
669
  The GNU General Public License does not permit incorporating your program
1052
330
  `Gnomovision' (which makes passes at compilers) written by James Hacker.
670
into proprietary programs.  If your program is a subroutine library, you
1053
331
671
may consider it more useful to permit linking proprietary applications with
1054
332
  <signature of Ty Coon>, 1 April 1989
672
the library.  If this is what you want to do, use the GNU Lesser General
1055
333
  Ty Coon, President of Vice
673
Public License instead of this License.  But first, please read
1056
334
674
<https://www.gnu.org/licenses/why-not-lgpl.html>.
1038
335
This General Public License does not permit incorporating your program into
1039
336
proprietary programs.  If your program is a subroutine library, you may
1040
337
consider it more useful to permit linking proprietary applications with the
1041
338
library.  If this is what you want to do, use the GNU Lesser General
1042
339
Public License instead of this License.
1057
340
675
1058
=== modified file 'copyright.txt'
1059
--- copyright.txt	2019-02-14 15:09:09 +0000
1060
+++ copyright.txt	2019-07-01 17:47:01 +0000
1061
@@ -1,21 +1,21 @@
1062
1
# -*- coding: utf-8 -*-
1
# -*- coding: utf-8 -*-
1063
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
1064
3
3
1083
4
###############################################################################
4
##########################################################################
1084
5
# OpenLP - Open Source Lyrics Projection                                      #
5
# OpenLP - Open Source Lyrics Projection                                 #
1085
6
# --------------------------------------------------------------------------- #
6
# ---------------------------------------------------------------------- #
1086
7
# Copyright (c) 2008-2019 OpenLP Developers                                   #
7
# Copyright (c) 2008-2019 OpenLP Developers                              #
1087
8
# --------------------------------------------------------------------------- #
8
# ---------------------------------------------------------------------- #
1088
9
# This program is free software; you can redistribute it and/or modify it     #
9
# This program is free software: you can redistribute it and/or modify   #
1089
10
# under the terms of the GNU General Public License as published by the Free  #
10
# it under the terms of the GNU General Public License as published by   #
1090
11
# Software Foundation; version 2 of the License.                              #
11
# the Free Software Foundation, either version 3 of the License, or      #
1091
12
#                                                                             #
12
# (at your option) any later version.                                    #
1092
13
# This program is distributed in the hope that it will be useful, but WITHOUT #
13
#                                                                        #
1093
14
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
14
# This program is distributed in the hope that it will be useful,        #
1094
15
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
15
# but WITHOUT ANY WARRANTY; without even the implied warranty of         #
1095
16
# more details.                                                               #
16
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          #
1096
17
#                                                                             #
17
# GNU General Public License for more details.                           #
1097
18
# You should have received a copy of the GNU General Public License along     #
18
#                                                                        #
1098
19
# with this program; if not, write to the Free Software Foundation, Inc., 59  #
19
# You should have received a copy of the GNU General Public License      #
1099
20
# Temple Place, Suite 330, Boston, MA 02111-1307 USA                          #
20
# along with this program.  If not, see <https://www.gnu.org/licenses/>. #
1100
21
###############################################################################
21
##########################################################################
1101
22
22
1102
=== removed file 'nose2.cfg'
1103
--- nose2.cfg	2017-12-02 05:31:23 +0000
1104
+++ nose2.cfg	1970-01-01 00:00:00 +0000
1105
@@ -1,27 +0,0 @@
1106
1
[unittest]
1107
2
verbose = true
1108
3
plugins = nose2.plugins.mp
1109
4
1110
5
[log-capture]
1111
6
always-on = true
1112
7
clear-handlers = true
1113
8
filter = -nose
1114
9
log-level = ERROR
1115
10
1116
11
[test-result]
1117
12
always-on = true
1118
13
descriptions = true
1119
14
1120
15
[coverage]
1121
16
always-on = true
1122
17
coverage = openlp
1123
18
coverage-report = html
1124
19
1125
20
[multiprocess]
1126
21
always-on = false
1127
22
processes = 4
1128
23
1129
24
[output-buffer]
1130
25
always-on = true
1131
26
stderr = true
1132
27
stdout = true
1133
28
0
1134
=== modified file 'openlp/__init__.py'
1135
--- openlp/__init__.py	2019-02-14 15:09:09 +0000
1136
+++ openlp/__init__.py	2019-07-01 17:47:01 +0000
1137
@@ -1,24 +1,24 @@
1138
1
# -*- coding: utf-8 -*-
1
# -*- coding: utf-8 -*-
1139
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
1140
3
3
1159
4
###############################################################################
4
##########################################################################
1160
5
# OpenLP - Open Source Lyrics Projection                                      #
5
# OpenLP - Open Source Lyrics Projection                                 #
1161
6
# --------------------------------------------------------------------------- #
6
# ---------------------------------------------------------------------- #
1162
7
# Copyright (c) 2008-2019 OpenLP Developers                                   #
7
# Copyright (c) 2008-2019 OpenLP Developers                              #
1163
8
# --------------------------------------------------------------------------- #
8
# ---------------------------------------------------------------------- #
1164
9
# This program is free software; you can redistribute it and/or modify it     #
9
# This program is free software: you can redistribute it and/or modify   #
1165
10
# under the terms of the GNU General Public License as published by the Free  #
10
# it under the terms of the GNU General Public License as published by   #
1166
11
# Software Foundation; version 2 of the License.                              #
11
# the Free Software Foundation, either version 3 of the License, or      #
1167
12
#                                                                             #
12
# (at your option) any later version.                                    #
1168
13
# This program is distributed in the hope that it will be useful, but WITHOUT #
13
#                                                                        #
1169
14
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
14
# This program is distributed in the hope that it will be useful,        #
1170
15
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
15
# but WITHOUT ANY WARRANTY; without even the implied warranty of         #
1171
16
# more details.                                                               #
16
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          #
1172
17
#                                                                             #
17
# GNU General Public License for more details.                           #
1173
18
# You should have received a copy of the GNU General Public License along     #
18
#                                                                        #
1174
19
# with this program; if not, write to the Free Software Foundation, Inc., 59  #
19
# You should have received a copy of the GNU General Public License      #
1175
20
# Temple Place, Suite 330, Boston, MA 02111-1307 USA                          #
20
# along with this program.  If not, see <https://www.gnu.org/licenses/>. #
1176
21
###############################################################################
21
##########################################################################
1177
22
"""
22
"""
1178
23
The :mod:`openlp` module contains all the project produced OpenLP functionality
23
The :mod:`openlp` module contains all the project produced OpenLP functionality
1179
24
"""
24
"""
1180
25
25
1181
=== modified file 'openlp/core/__init__.py'
1182
--- openlp/core/__init__.py	2019-02-14 15:09:09 +0000
1183
+++ openlp/core/__init__.py	2019-07-01 17:47:01 +0000
1184
@@ -1,24 +1,24 @@
1185
1
# -*- coding: utf-8 -*-
1
# -*- coding: utf-8 -*-
1186
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
1187
3
3
1206
4
###############################################################################
4
##########################################################################
1207
5
# OpenLP - Open Source Lyrics Projection                                      #
5
# OpenLP - Open Source Lyrics Projection                                 #
1208
6
# --------------------------------------------------------------------------- #
6
# ---------------------------------------------------------------------- #
1209
7
# Copyright (c) 2008-2019 OpenLP Developers                                   #
7
# Copyright (c) 2008-2019 OpenLP Developers                              #
1210
8
# --------------------------------------------------------------------------- #
8
# ---------------------------------------------------------------------- #
1211
9
# This program is free software; you can redistribute it and/or modify it     #
9
# This program is free software: you can redistribute it and/or modify   #
1212
10
# under the terms of the GNU General Public License as published by the Free  #
10
# it under the terms of the GNU General Public License as published by   #
1213
11
# Software Foundation; version 2 of the License.                              #
11
# the Free Software Foundation, either version 3 of the License, or      #
1214
12
#                                                                             #
12
# (at your option) any later version.                                    #
1215
13
# This program is distributed in the hope that it will be useful, but WITHOUT #
13
#                                                                        #
1216
14
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
14
# This program is distributed in the hope that it will be useful,        #
1217
15
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
15
# but WITHOUT ANY WARRANTY; without even the implied warranty of         #
1218
16
# more details.                                                               #
16
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          #
1219
17
#                                                                             #
17
# GNU General Public License for more details.                           #
1220
18
# You should have received a copy of the GNU General Public License along     #
18
#                                                                        #
1221
19
# with this program; if not, write to the Free Software Foundation, Inc., 59  #
19
# You should have received a copy of the GNU General Public License      #
1222
20
# Temple Place, Suite 330, Boston, MA 02111-1307 USA                          #
20
# along with this program.  If not, see <https://www.gnu.org/licenses/>. #
1223
21
###############################################################################
21
##########################################################################
1224
22
22
1225
23
"""
23
"""
1226
24
The :mod:`core` module provides all core application functions
24
The :mod:`core` module provides all core application functions
1227
25
25
1228
=== modified file 'openlp/core/api/__init__.py'
1229
--- openlp/core/api/__init__.py	2019-02-14 15:09:09 +0000
1230
+++ openlp/core/api/__init__.py	2019-07-01 17:47:01 +0000
1231
@@ -1,21 +1,21 @@
1232
1
# -*- coding: utf-8 -*-
1
# -*- coding: utf-8 -*-
1233
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
1234
3
3
1253
4
###############################################################################
4
##########################################################################
1254
5
# OpenLP - Open Source Lyrics Projection                                      #
5
# OpenLP - Open Source Lyrics Projection                                 #
1255
6
# --------------------------------------------------------------------------- #
6
# ---------------------------------------------------------------------- #
1256
7
# Copyright (c) 2008-2019 OpenLP Developers                                   #
7
# Copyright (c) 2008-2019 OpenLP Developers                              #
1257
8
# --------------------------------------------------------------------------- #
8
# ---------------------------------------------------------------------- #
1258
9
# This program is free software; you can redistribute it and/or modify it     #
9
# This program is free software: you can redistribute it and/or modify   #
1259
10
# under the terms of the GNU General Public License as published by the Free  #
10
# it under the terms of the GNU General Public License as published by   #
1260
11
# Software Foundation; version 2 of the License.                              #
11
# the Free Software Foundation, either version 3 of the License, or      #
1261
12
#                                                                             #
12
# (at your option) any later version.                                    #
1262
13
# This program is distributed in the hope that it will be useful, but WITHOUT #
13
#                                                                        #
1263
14
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
14
# This program is distributed in the hope that it will be useful,        #
1264
15
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
15
# but WITHOUT ANY WARRANTY; without even the implied warranty of         #
1265
16
# more details.                                                               #
16
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          #
1266
17
#                                                                             #
17
# GNU General Public License for more details.                           #
1267
18
# You should have received a copy of the GNU General Public License along     #
18
#                                                                        #
1268
19
# with this program; if not, write to the Free Software Foundation, Inc., 59  #
19
# You should have received a copy of the GNU General Public License      #
1269
20
# Temple Place, Suite 330, Boston, MA 02111-1307 USA                          #
20
# along with this program.  If not, see <https://www.gnu.org/licenses/>. #
1270
21
###############################################################################
21
##########################################################################
1271
22
22
1272
=== modified file 'openlp/core/api/deploy.py'
1273
--- openlp/core/api/deploy.py	2019-02-14 15:09:09 +0000
1274
+++ openlp/core/api/deploy.py	2019-07-01 17:47:01 +0000
1275
@@ -1,24 +1,24 @@
1276
1
# -*- coding: utf-8 -*-
1
# -*- coding: utf-8 -*-
1277
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
1278
3
3
1297
4
###############################################################################
4
##########################################################################
1298
5
# OpenLP - Open Source Lyrics Projection                                      #
5
# OpenLP - Open Source Lyrics Projection                                 #
1299
6
# --------------------------------------------------------------------------- #
6
# ---------------------------------------------------------------------- #
1300
7
# Copyright (c) 2008-2019 OpenLP Developers                                   #
7
# Copyright (c) 2008-2019 OpenLP Developers                              #
1301
8
# --------------------------------------------------------------------------- #
8
# ---------------------------------------------------------------------- #
1302
9
# This program is free software; you can redistribute it and/or modify it     #
9
# This program is free software: you can redistribute it and/or modify   #
1303
10
# under the terms of the GNU General Public License as published by the Free  #
10
# it under the terms of the GNU General Public License as published by   #
1304
11
# Software Foundation; version 2 of the License.                              #
11
# the Free Software Foundation, either version 3 of the License, or      #
1305
12
#                                                                             #
12
# (at your option) any later version.                                    #
1306
13
# This program is distributed in the hope that it will be useful, but WITHOUT #
13
#                                                                        #
1307
14
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
14
# This program is distributed in the hope that it will be useful,        #
1308
15
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
15
# but WITHOUT ANY WARRANTY; without even the implied warranty of         #
1309
16
# more details.                                                               #
16
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          #
1310
17
#                                                                             #
17
# GNU General Public License for more details.                           #
1311
18
# You should have received a copy of the GNU General Public License along     #
18
#                                                                        #
1312
19
# with this program; if not, write to the Free Software Foundation, Inc., 59  #
19
# You should have received a copy of the GNU General Public License      #
1313
20
# Temple Place, Suite 330, Boston, MA 02111-1307 USA                          #
20
# along with this program.  If not, see <https://www.gnu.org/licenses/>. #
1314
21
###############################################################################
21
##########################################################################
1315
22
"""
22
"""
1316
23
Download and "install" the remote web client
23
Download and "install" the remote web client
1317
24
"""
24
"""
1318
@@ -34,13 +34,13 @@
1319
34
    Process the downloaded zip file and add to the correct directory
34
    Process the downloaded zip file and add to the correct directory
1320
35
35
1321
36
    :param str zip_name: the zip file name to be processed
36
    :param str zip_name: the zip file name to be processed
1323
37
    :param openlp.core.common.path.Path app_root_path: The directory to expand the zip to
37
    :param pathlib.Path app_root_path: The directory to expand the zip to
1324
38
38
1325
39
    :return: None
39
    :return: None
1326
40
    """
40
    """
1327
41
    zip_path = app_root_path / zip_name
41
    zip_path = app_root_path / zip_name
1330
42
    web_zip = ZipFile(str(zip_path))
42
    web_zip = ZipFile(zip_path)
1331
43
    web_zip.extractall(str(app_root_path))
43
    web_zip.extractall(app_root_path)
1332
44
44
1333
45
45
1334
46
def download_sha256():
46
def download_sha256():
1335
47
47
1336
=== modified file 'openlp/core/api/endpoint/__init__.py'
1337
--- openlp/core/api/endpoint/__init__.py	2019-02-14 15:09:09 +0000
1338
+++ openlp/core/api/endpoint/__init__.py	2019-07-01 17:47:01 +0000
1339
@@ -1,24 +1,24 @@
1340
1
# -*- coding: utf-8 -*-
1
# -*- coding: utf-8 -*-
1341
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
1342
3
3
1361
4
###############################################################################
4
##########################################################################
1362
5
# OpenLP - Open Source Lyrics Projection                                      #
5
# OpenLP - Open Source Lyrics Projection                                 #
1363
6
# --------------------------------------------------------------------------- #
6
# ---------------------------------------------------------------------- #
1364
7
# Copyright (c) 2008-2019 OpenLP Developers                                   #
7
# Copyright (c) 2008-2019 OpenLP Developers                              #
1365
8
# --------------------------------------------------------------------------- #
8
# ---------------------------------------------------------------------- #
1366
9
# This program is free software; you can redistribute it and/or modify it     #
9
# This program is free software: you can redistribute it and/or modify   #
1367
10
# under the terms of the GNU General Public License as published by the Free  #
10
# it under the terms of the GNU General Public License as published by   #
1368
11
# Software Foundation; version 2 of the License.                              #
11
# the Free Software Foundation, either version 3 of the License, or      #
1369
12
#                                                                             #
12
# (at your option) any later version.                                    #
1370
13
# This program is distributed in the hope that it will be useful, but WITHOUT #
13
#                                                                        #
1371
14
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
14
# This program is distributed in the hope that it will be useful,        #
1372
15
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
15
# but WITHOUT ANY WARRANTY; without even the implied warranty of         #
1373
16
# more details.                                                               #
16
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          #
1374
17
#                                                                             #
17
# GNU General Public License for more details.                           #
1375
18
# You should have received a copy of the GNU General Public License along     #
18
#                                                                        #
1376
19
# with this program; if not, write to the Free Software Foundation, Inc., 59  #
19
# You should have received a copy of the GNU General Public License      #
1377
20
# Temple Place, Suite 330, Boston, MA 02111-1307 USA                          #
20
# along with this program.  If not, see <https://www.gnu.org/licenses/>. #
1378
21
###############################################################################
21
##########################################################################
1379
22
"""
22
"""
1380
23
The Endpoint class, which provides plugins with a way to serve their own portion of the API
23
The Endpoint class, which provides plugins with a way to serve their own portion of the API
1381
24
"""
24
"""
1382
25
25
1383
=== modified file 'openlp/core/api/endpoint/controller.py'
1384
--- openlp/core/api/endpoint/controller.py	2019-02-14 15:09:09 +0000
1385
+++ openlp/core/api/endpoint/controller.py	2019-07-01 17:47:01 +0000
1386
@@ -1,34 +1,34 @@
1387
1
# -*- coding: utf-8 -*-
1
# -*- coding: utf-8 -*-
1388
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
1389
3
3
1408
4
###############################################################################
4
##########################################################################
1409
5
# OpenLP - Open Source Lyrics Projection                                      #
5
# OpenLP - Open Source Lyrics Projection                                 #
1410
6
# --------------------------------------------------------------------------- #
6
# ---------------------------------------------------------------------- #
1411
7
# Copyright (c) 2008-2019 OpenLP Developers                                   #
7
# Copyright (c) 2008-2019 OpenLP Developers                              #
1412
8
# --------------------------------------------------------------------------- #
8
# ---------------------------------------------------------------------- #
1413
9
# This program is free software; you can redistribute it and/or modify it     #
9
# This program is free software: you can redistribute it and/or modify   #
1414
10
# under the terms of the GNU General Public License as published by the Free  #
10
# it under the terms of the GNU General Public License as published by   #
1415
11
# Software Foundation; version 2 of the License.                              #
11
# the Free Software Foundation, either version 3 of the License, or      #
1416
12
#                                                                             #
12
# (at your option) any later version.                                    #
1417
13
# This program is distributed in the hope that it will be useful, but WITHOUT #
13
#                                                                        #
1418
14
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
14
# This program is distributed in the hope that it will be useful,        #
1419
15
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
15
# but WITHOUT ANY WARRANTY; without even the implied warranty of         #
1420
16
# more details.                                                               #
16
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          #
1421
17
#                                                                             #
17
# GNU General Public License for more details.                           #
1422
18
# You should have received a copy of the GNU General Public License along     #
18
#                                                                        #
1423
19
# with this program; if not, write to the Free Software Foundation, Inc., 59  #
19
# You should have received a copy of the GNU General Public License      #
1424
20
# Temple Place, Suite 330, Boston, MA 02111-1307 USA                          #
20
# along with this program.  If not, see <https://www.gnu.org/licenses/>. #
1425
21
###############################################################################
21
##########################################################################
1426
22
import json
22
import json
1427
23
import logging
23
import logging
1428
24
import os
24
import os
1429
25
import urllib.error
25
import urllib.error
1430
26
import urllib.request
26
import urllib.request
1431
27
from pathlib import Path
1432
27
28
1433
28
from openlp.core.api.http import requires_auth
29
from openlp.core.api.http import requires_auth
1434
29
from openlp.core.api.http.endpoint import Endpoint
30
from openlp.core.api.http.endpoint import Endpoint
1435
30
from openlp.core.common.applocation import AppLocation
31
from openlp.core.common.applocation import AppLocation
1436
31
from openlp.core.common.path import Path
1437
32
from openlp.core.common.registry import Registry
32
from openlp.core.common.registry import Registry
1438
33
from openlp.core.common.settings import Settings
33
from openlp.core.common.settings import Settings
1439
34
from openlp.core.lib import create_thumb
34
from openlp.core.lib import create_thumb
1440
35
35
1441
=== modified file 'openlp/core/api/endpoint/core.py'
1442
--- openlp/core/api/endpoint/core.py	2019-02-14 15:09:09 +0000
1443
+++ openlp/core/api/endpoint/core.py	2019-07-01 17:47:01 +0000
1444
@@ -1,24 +1,24 @@
1445
1
# -*- coding: utf-8 -*-
1
# -*- coding: utf-8 -*-
1446
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
1447
3
3
1466
4
###############################################################################
4
##########################################################################
1467
5
# OpenLP - Open Source Lyrics Projection                                      #
5
# OpenLP - Open Source Lyrics Projection                                 #
1468
6
# --------------------------------------------------------------------------- #
6
# ---------------------------------------------------------------------- #
1469
7
# Copyright (c) 2008-2019 OpenLP Developers                                   #
7
# Copyright (c) 2008-2019 OpenLP Developers                              #
1470
8
# --------------------------------------------------------------------------- #
8
# ---------------------------------------------------------------------- #
1471
9
# This program is free software; you can redistribute it and/or modify it     #
9
# This program is free software: you can redistribute it and/or modify   #
1472
10
# under the terms of the GNU General Public License as published by the Free  #
10
# it under the terms of the GNU General Public License as published by   #
1473
11
# Software Foundation; version 2 of the License.                              #
11
# the Free Software Foundation, either version 3 of the License, or      #
1474
12
#                                                                             #
12
# (at your option) any later version.                                    #
1475
13
# This program is distributed in the hope that it will be useful, but WITHOUT #
13
#                                                                        #
1476
14
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
14
# This program is distributed in the hope that it will be useful,        #
1477
15
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
15
# but WITHOUT ANY WARRANTY; without even the implied warranty of         #
1478
16
# more details.                                                               #
16
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          #
1479
17
#                                                                             #
17
# GNU General Public License for more details.                           #
1480
18
# You should have received a copy of the GNU General Public License along     #
18
#                                                                        #
1481
19
# with this program; if not, write to the Free Software Foundation, Inc., 59  #
19
# You should have received a copy of the GNU General Public License      #
1482
20
# Temple Place, Suite 330, Boston, MA 02111-1307 USA                          #
20
# along with this program.  If not, see <https://www.gnu.org/licenses/>. #
1483
21
###############################################################################
21
##########################################################################
1484
22
"""
22
"""
1485
23
The :mod:`~openlp.core.api.endpoint.core` module contains the core API endpoints
23
The :mod:`~openlp.core.api.endpoint.core` module contains the core API endpoints
1486
24
"""
24
"""
1487
25
25
1488
=== modified file 'openlp/core/api/endpoint/pluginhelpers.py'
1489
--- openlp/core/api/endpoint/pluginhelpers.py	2019-02-14 15:09:09 +0000
1490
+++ openlp/core/api/endpoint/pluginhelpers.py	2019-07-01 17:47:01 +0000
1491
@@ -1,24 +1,24 @@
1492
1
# -*- coding: utf-8 -*-
1
# -*- coding: utf-8 -*-
1493
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
1494
3
3
1513
4
###############################################################################
4
##########################################################################
1514
5
# OpenLP - Open Source Lyrics Projection                                      #
5
# OpenLP - Open Source Lyrics Projection                                 #
1515
6
# --------------------------------------------------------------------------- #
6
# ---------------------------------------------------------------------- #
1516
7
# Copyright (c) 2008-2019 OpenLP Developers                                   #
7
# Copyright (c) 2008-2019 OpenLP Developers                              #
1517
8
# --------------------------------------------------------------------------- #
8
# ---------------------------------------------------------------------- #
1518
9
# This program is free software; you can redistribute it and/or modify it     #
9
# This program is free software: you can redistribute it and/or modify   #
1519
10
# under the terms of the GNU General Public License as published by the Free  #
10
# it under the terms of the GNU General Public License as published by   #
1520
11
# Software Foundation; version 2 of the License.                              #
11
# the Free Software Foundation, either version 3 of the License, or      #
1521
12
#                                                                             #
12
# (at your option) any later version.                                    #
1522
13
# This program is distributed in the hope that it will be useful, but WITHOUT #
13
#                                                                        #
1523
14
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
14
# This program is distributed in the hope that it will be useful,        #
1524
15
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
15
# but WITHOUT ANY WARRANTY; without even the implied warranty of         #
1525
16
# more details.                                                               #
16
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          #
1526
17
#                                                                             #
17
# GNU General Public License for more details.                           #
1527
18
# You should have received a copy of the GNU General Public License along     #
18
#                                                                        #
1528
19
# with this program; if not, write to the Free Software Foundation, Inc., 59  #
19
# You should have received a copy of the GNU General Public License      #
1529
20
# Temple Place, Suite 330, Boston, MA 02111-1307 USA                          #
20
# along with this program.  If not, see <https://www.gnu.org/licenses/>. #
1530
21
###############################################################################
21
##########################################################################
1531
22
import json
22
import json
1532
23
import re
23
import re
1533
24
import urllib
24
import urllib
1534
25
25
1535
=== modified file 'openlp/core/api/endpoint/remote.py'
1536
--- openlp/core/api/endpoint/remote.py	2019-02-14 15:09:09 +0000
1537
+++ openlp/core/api/endpoint/remote.py	2019-07-01 17:47:01 +0000
1538
@@ -1,24 +1,24 @@
1539
1
# -*- coding: utf-8 -*-
1
# -*- coding: utf-8 -*-
1540
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
1541
3
3
1560
4
###############################################################################
4
##########################################################################
1561
5
# OpenLP - Open Source Lyrics Projection                                      #
5
# OpenLP - Open Source Lyrics Projection                                 #
1562
6
# --------------------------------------------------------------------------- #
6
# ---------------------------------------------------------------------- #
1563
7
# Copyright (c) 2008-2019 OpenLP Developers                                   #
7
# Copyright (c) 2008-2019 OpenLP Developers                              #
1564
8
# --------------------------------------------------------------------------- #
8
# ---------------------------------------------------------------------- #
1565
9
# This program is free software; you can redistribute it and/or modify it     #
9
# This program is free software: you can redistribute it and/or modify   #
1566
10
# under the terms of the GNU General Public License as published by the Free  #
10
# it under the terms of the GNU General Public License as published by   #
1567
11
# Software Foundation; version 2 of the License.                              #
11
# the Free Software Foundation, either version 3 of the License, or      #
1568
12
#                                                                             #
12
# (at your option) any later version.                                    #
1569
13
# This program is distributed in the hope that it will be useful, but WITHOUT #
13
#                                                                        #
1570
14
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
14
# This program is distributed in the hope that it will be useful,        #
1571
15
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
15
# but WITHOUT ANY WARRANTY; without even the implied warranty of         #
1572
16
# more details.                                                               #
16
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          #
1573
17
#                                                                             #
17
# GNU General Public License for more details.                           #
1574
18
# You should have received a copy of the GNU General Public License along     #
18
#                                                                        #
1575
19
# with this program; if not, write to the Free Software Foundation, Inc., 59  #
19
# You should have received a copy of the GNU General Public License      #
1576
20
# Temple Place, Suite 330, Boston, MA 02111-1307 USA                          #
20
# along with this program.  If not, see <https://www.gnu.org/licenses/>. #
1577
21
###############################################################################
21
##########################################################################
1578
22
import logging
22
import logging
1579
23
23
1580
24
from openlp.core.api.endpoint.core import TRANSLATED_STRINGS
24
from openlp.core.api.endpoint.core import TRANSLATED_STRINGS
1581
25
25
1582
=== modified file 'openlp/core/api/endpoint/service.py'
1583
--- openlp/core/api/endpoint/service.py	2019-02-14 15:09:09 +0000
1584
+++ openlp/core/api/endpoint/service.py	2019-07-01 17:47:01 +0000
1585
@@ -1,24 +1,24 @@
1586
1
# -*- coding: utf-8 -*-
1
# -*- coding: utf-8 -*-
1587
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
1588
3
3
1607
4
###############################################################################
4
##########################################################################
1608
5
# OpenLP - Open Source Lyrics Projection                                      #
5
# OpenLP - Open Source Lyrics Projection                                 #
1609
6
# --------------------------------------------------------------------------- #
6
# ---------------------------------------------------------------------- #
1610
7
# Copyright (c) 2008-2019 OpenLP Developers                                   #
7
# Copyright (c) 2008-2019 OpenLP Developers                              #
1611
8
# --------------------------------------------------------------------------- #
8
# ---------------------------------------------------------------------- #
1612
9
# This program is free software; you can redistribute it and/or modify it     #
9
# This program is free software: you can redistribute it and/or modify   #
1613
10
# under the terms of the GNU General Public License as published by the Free  #
10
# it under the terms of the GNU General Public License as published by   #
1614
11
# Software Foundation; version 2 of the License.                              #
11
# the Free Software Foundation, either version 3 of the License, or      #
1615
12
#                                                                             #
12
# (at your option) any later version.                                    #
1616
13
# This program is distributed in the hope that it will be useful, but WITHOUT #
13
#                                                                        #
1617
14
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
14
# This program is distributed in the hope that it will be useful,        #
1618
15
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
15
# but WITHOUT ANY WARRANTY; without even the implied warranty of         #
1619
16
# more details.                                                               #
16
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          #
1620
17
#                                                                             #
17
# GNU General Public License for more details.                           #
1621
18
# You should have received a copy of the GNU General Public License along     #
18
#                                                                        #
1622
19
# with this program; if not, write to the Free Software Foundation, Inc., 59  #
19
# You should have received a copy of the GNU General Public License      #
1623
20
# Temple Place, Suite 330, Boston, MA 02111-1307 USA                          #
20
# along with this program.  If not, see <https://www.gnu.org/licenses/>. #
1624
21
###############################################################################
21
##########################################################################
1625
22
import json
22
import json
1626
23
import logging
23
import logging
1627
24
24
1628
25
25
1629
=== modified file 'openlp/core/api/http/__init__.py'
1630
--- openlp/core/api/http/__init__.py	2019-02-14 15:09:09 +0000
1631
+++ openlp/core/api/http/__init__.py	2019-07-01 17:47:01 +0000
1632
@@ -1,24 +1,24 @@
1633
1
# -*- coding: utf-8 -*-
1
# -*- coding: utf-8 -*-
1634
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
1635
3
3
1654
4
###############################################################################
4
##########################################################################
1655
5
# OpenLP - Open Source Lyrics Projection                                      #
5
# OpenLP - Open Source Lyrics Projection                                 #
1656
6
# --------------------------------------------------------------------------- #
6
# ---------------------------------------------------------------------- #
1657
7
# Copyright (c) 2008-2019 OpenLP Developers                                   #
7
# Copyright (c) 2008-2019 OpenLP Developers                              #
1658
8
# --------------------------------------------------------------------------- #
8
# ---------------------------------------------------------------------- #
1659
9
# This program is free software; you can redistribute it and/or modify it     #
9
# This program is free software: you can redistribute it and/or modify   #
1660
10
# under the terms of the GNU General Public License as published by the Free  #
10
# it under the terms of the GNU General Public License as published by   #
1661
11
# Software Foundation; version 2 of the License.                              #
11
# the Free Software Foundation, either version 3 of the License, or      #
1662
12
#                                                                             #
12
# (at your option) any later version.                                    #
1663
13
# This program is distributed in the hope that it will be useful, but WITHOUT #
13
#                                                                        #
1664
14
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
14
# This program is distributed in the hope that it will be useful,        #
1665
15
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
15
# but WITHOUT ANY WARRANTY; without even the implied warranty of         #
1666
16
# more details.                                                               #
16
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          #
1667
17
#                                                                             #
17
# GNU General Public License for more details.                           #
1668
18
# You should have received a copy of the GNU General Public License along     #
18
#                                                                        #
1669
19
# with this program; if not, write to the Free Software Foundation, Inc., 59  #
19
# You should have received a copy of the GNU General Public License      #
1670
20
# Temple Place, Suite 330, Boston, MA 02111-1307 USA                          #
20
# along with this program.  If not, see <https://www.gnu.org/licenses/>. #
1671
21
###############################################################################
21
##########################################################################
1672
22
22
1673
23
import base64
23
import base64
1674
24
from functools import wraps
24
from functools import wraps
1675
25
25
1676
=== modified file 'openlp/core/api/http/endpoint.py'
1677
--- openlp/core/api/http/endpoint.py	2019-02-14 15:09:09 +0000
1678
+++ openlp/core/api/http/endpoint.py	2019-07-01 17:47:01 +0000
1679
@@ -1,24 +1,24 @@
1680
1
# -*- coding: utf-8 -*-
1
# -*- coding: utf-8 -*-
1681
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
1682
3
3
1701
4
###############################################################################
4
##########################################################################
1702
5
# OpenLP - Open Source Lyrics Projection                                      #
5
# OpenLP - Open Source Lyrics Projection                                 #
1703
6
# --------------------------------------------------------------------------- #
6
# ---------------------------------------------------------------------- #
1704
7
# Copyright (c) 2008-2019 OpenLP Developers                                   #
7
# Copyright (c) 2008-2019 OpenLP Developers                              #
1705
8
# --------------------------------------------------------------------------- #
8
# ---------------------------------------------------------------------- #
1706
9
# This program is free software; you can redistribute it and/or modify it     #
9
# This program is free software: you can redistribute it and/or modify   #
1707
10
# under the terms of the GNU General Public License as published by the Free  #
10
# it under the terms of the GNU General Public License as published by   #
1708
11
# Software Foundation; version 2 of the License.                              #
11
# the Free Software Foundation, either version 3 of the License, or      #
1709
12
#                                                                             #
12
# (at your option) any later version.                                    #
1710
13
# This program is distributed in the hope that it will be useful, but WITHOUT #
13
#                                                                        #
1711
14
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
14
# This program is distributed in the hope that it will be useful,        #
1712
15
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
15
# but WITHOUT ANY WARRANTY; without even the implied warranty of         #
1713
16
# more details.                                                               #
16
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          #
1714
17
#                                                                             #
17
# GNU General Public License for more details.                           #
1715
18
# You should have received a copy of the GNU General Public License along     #
18
#                                                                        #
1716
19
# with this program; if not, write to the Free Software Foundation, Inc., 59  #
19
# You should have received a copy of the GNU General Public License      #
1717
20
# Temple Place, Suite 330, Boston, MA 02111-1307 USA                          #
20
# along with this program.  If not, see <https://www.gnu.org/licenses/>. #
1718
21
###############################################################################
21
##########################################################################
1719
22
"""
22
"""
1720
23
The Endpoint class, which provides plugins with a way to serve their own portion of the API
23
The Endpoint class, which provides plugins with a way to serve their own portion of the API
1721
24
"""
24
"""
1722
25
25
1723
=== modified file 'openlp/core/api/http/errors.py'
1724
--- openlp/core/api/http/errors.py	2019-02-14 15:09:09 +0000
1725
+++ openlp/core/api/http/errors.py	2019-07-01 17:47:01 +0000
1726
@@ -1,24 +1,24 @@
1727
1
# -*- coding: utf-8 -*-
1
# -*- coding: utf-8 -*-
1728
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
1729
3
3
1748
4
###############################################################################
4
##########################################################################
1749
5
# OpenLP - Open Source Lyrics Projection                                      #
5
# OpenLP - Open Source Lyrics Projection                                 #
1750
6
# --------------------------------------------------------------------------- #
6
# ---------------------------------------------------------------------- #
1751
7
# Copyright (c) 2008-2019 OpenLP Developers                                   #
7
# Copyright (c) 2008-2019 OpenLP Developers                              #
1752
8
# --------------------------------------------------------------------------- #
8
# ---------------------------------------------------------------------- #
1753
9
# This program is free software; you can redistribute it and/or modify it     #
9
# This program is free software: you can redistribute it and/or modify   #
1754
10
# under the terms of the GNU General Public License as published by the Free  #
10
# it under the terms of the GNU General Public License as published by   #
1755
11
# Software Foundation; version 2 of the License.                              #
11
# the Free Software Foundation, either version 3 of the License, or      #
1756
12
#                                                                             #
12
# (at your option) any later version.                                    #
1757
13
# This program is distributed in the hope that it will be useful, but WITHOUT #
13
#                                                                        #
1758
14
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
14
# This program is distributed in the hope that it will be useful,        #
1759
15
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
15
# but WITHOUT ANY WARRANTY; without even the implied warranty of         #
1760
16
# more details.                                                               #
16
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          #
1761
17
#                                                                             #
17
# GNU General Public License for more details.                           #
1762
18
# You should have received a copy of the GNU General Public License along     #
18
#                                                                        #
1763
19
# with this program; if not, write to the Free Software Foundation, Inc., 59  #
19
# You should have received a copy of the GNU General Public License      #
1764
20
# Temple Place, Suite 330, Boston, MA 02111-1307 USA                          #
20
# along with this program.  If not, see <https://www.gnu.org/licenses/>. #
1765
21
###############################################################################
21
##########################################################################
1766
22
"""
22
"""
1767
23
HTTP Error classes
23
HTTP Error classes
1768
24
"""
24
"""
1769
25
25
1770
=== modified file 'openlp/core/api/http/server.py'
1771
--- openlp/core/api/http/server.py	2019-02-14 15:09:09 +0000
1772
+++ openlp/core/api/http/server.py	2019-07-01 17:47:01 +0000
1773
@@ -1,24 +1,24 @@
1774
1
# -*- coding: utf-8 -*-
1
# -*- coding: utf-8 -*-
1775
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
1776
3
3
1795
4
###############################################################################
4
##########################################################################
1796
5
# OpenLP - Open Source Lyrics Projection                                      #
5
# OpenLP - Open Source Lyrics Projection                                 #
1797
6
# --------------------------------------------------------------------------- #
6
# ---------------------------------------------------------------------- #
1798
7
# Copyright (c) 2008-2019 OpenLP Developers                                   #
7
# Copyright (c) 2008-2019 OpenLP Developers                              #
1799
8
# --------------------------------------------------------------------------- #
8
# ---------------------------------------------------------------------- #
1800
9
# This program is free software; you can redistribute it and/or modify it     #
9
# This program is free software: you can redistribute it and/or modify   #
1801
10
# under the terms of the GNU General Public License as published by the Free  #
10
# it under the terms of the GNU General Public License as published by   #
1802
11
# Software Foundation; version 2 of the License.                              #
11
# the Free Software Foundation, either version 3 of the License, or      #
1803
12
#                                                                             #
12
# (at your option) any later version.                                    #
1804
13
# This program is distributed in the hope that it will be useful, but WITHOUT #
13
#                                                                        #
1805
14
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
14
# This program is distributed in the hope that it will be useful,        #
1806
15
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
15
# but WITHOUT ANY WARRANTY; without even the implied warranty of         #
1807
16
# more details.                                                               #
16
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          #
1808
17
#                                                                             #
17
# GNU General Public License for more details.                           #
1809
18
# You should have received a copy of the GNU General Public License along     #
18
#                                                                        #
1810
19
# with this program; if not, write to the Free Software Foundation, Inc., 59  #
19
# You should have received a copy of the GNU General Public License      #
1811
20
# Temple Place, Suite 330, Boston, MA 02111-1307 USA                          #
20
# along with this program.  If not, see <https://www.gnu.org/licenses/>. #
1812
21
###############################################################################
21
##########################################################################
1813
22
"""
22
"""
1814
23
The :mod:`http` module contains the API web server. This is a lightweight web server used by remotes to interact
23
The :mod:`http` module contains the API web server. This is a lightweight web server used by remotes to interact
1815
24
with OpenLP. It uses JSON to communicate with the remotes.
24
with OpenLP. It uses JSON to communicate with the remotes.
1816
25
25
1817
=== modified file 'openlp/core/api/http/wsgiapp.py'
1818
--- openlp/core/api/http/wsgiapp.py	2019-02-14 15:09:09 +0000
1819
+++ openlp/core/api/http/wsgiapp.py	2019-07-01 17:47:01 +0000
1820
@@ -2,24 +2,24 @@
1821
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
1822
3
# pylint: disable=logging-format-interpolation
3
# pylint: disable=logging-format-interpolation
1823
4
4
1842
5
###############################################################################
5
##########################################################################
1843
6
# OpenLP - Open Source Lyrics Projection                                      #
6
# OpenLP - Open Source Lyrics Projection                                 #
1844
7
# --------------------------------------------------------------------------- #
7
# ---------------------------------------------------------------------- #
1845
8
# Copyright (c) 2008-2019 OpenLP Developers                                   #
8
# Copyright (c) 2008-2019 OpenLP Developers                              #
1846
9
# --------------------------------------------------------------------------- #
9
# ---------------------------------------------------------------------- #
1847
10
# This program is free software; you can redistribute it and/or modify it     #
10
# This program is free software: you can redistribute it and/or modify   #
1848
11
# under the terms of the GNU General Public License as published by the Free  #
11
# it under the terms of the GNU General Public License as published by   #
1849
12
# Software Foundation; version 2 of the License.                              #
12
# the Free Software Foundation, either version 3 of the License, or      #
1850
13
#                                                                             #
13
# (at your option) any later version.                                    #
1851
14
# This program is distributed in the hope that it will be useful, but WITHOUT #
14
#                                                                        #
1852
15
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
15
# This program is distributed in the hope that it will be useful,        #
1853
16
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
16
# but WITHOUT ANY WARRANTY; without even the implied warranty of         #
1854
17
# more details.                                                               #
17
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          #
1855
18
#                                                                             #
18
# GNU General Public License for more details.                           #
1856
19
# You should have received a copy of the GNU General Public License along     #
19
#                                                                        #
1857
20
# with this program; if not, write to the Free Software Foundation, Inc., 59  #
20
# You should have received a copy of the GNU General Public License      #
1858
21
# Temple Place, Suite 330, Boston, MA 02111-1307 USA                          #
21
# along with this program.  If not, see <https://www.gnu.org/licenses/>. #
1859
22
###############################################################################
22
##########################################################################
1860
23
"""
23
"""
1861
24
App stuff
24
App stuff
1862
25
"""
25
"""
1863
26
26
1864
=== modified file 'openlp/core/api/poll.py'
1865
--- openlp/core/api/poll.py	2019-02-14 15:09:09 +0000
1866
+++ openlp/core/api/poll.py	2019-07-01 17:47:01 +0000
1867
@@ -1,24 +1,24 @@
1868
1
# -*- coding: utf-8 -*-
1
# -*- coding: utf-8 -*-
1869
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
1870
3
3
1889
4
###############################################################################
4
##########################################################################
1890
5
# OpenLP - Open Source Lyrics Projection                                      #
5
# OpenLP - Open Source Lyrics Projection                                 #
1891
6
# --------------------------------------------------------------------------- #
6
# ---------------------------------------------------------------------- #
1892
7
# Copyright (c) 2008-2019 OpenLP Developers                                   #
7
# Copyright (c) 2008-2019 OpenLP Developers                              #
1893
8
# --------------------------------------------------------------------------- #
8
# ---------------------------------------------------------------------- #
1894
9
# This program is free software; you can redistribute it and/or modify it     #
9
# This program is free software: you can redistribute it and/or modify   #
1895
10
# under the terms of the GNU General Public License as published by the Free  #
10
# it under the terms of the GNU General Public License as published by   #
1896
11
# Software Foundation; version 2 of the License.                              #
11
# the Free Software Foundation, either version 3 of the License, or      #
1897
12
#                                                                             #
12
# (at your option) any later version.                                    #
1898
13
# This program is distributed in the hope that it will be useful, but WITHOUT #
13
#                                                                        #
1899
14
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
14
# This program is distributed in the hope that it will be useful,        #
1900
15
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
15
# but WITHOUT ANY WARRANTY; without even the implied warranty of         #
1901
16
# more details.                                                               #
16
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          #
1902
17
#                                                                             #
17
# GNU General Public License for more details.                           #
1903
18
# You should have received a copy of the GNU General Public License along     #
18
#                                                                        #
1904
19
# with this program; if not, write to the Free Software Foundation, Inc., 59  #
19
# You should have received a copy of the GNU General Public License      #
1905
20
# Temple Place, Suite 330, Boston, MA 02111-1307 USA                          #
20
# along with this program.  If not, see <https://www.gnu.org/licenses/>. #
1906
21
###############################################################################
21
##########################################################################
1907
22
22
1908
23
import json
23
import json
1909
24
24
1910
25
25
1911
=== modified file 'openlp/core/api/tab.py'
1912
--- openlp/core/api/tab.py	2019-02-14 15:09:09 +0000
1913
+++ openlp/core/api/tab.py	2019-07-01 17:47:01 +0000
1914
@@ -1,24 +1,24 @@
1915
1
# -*- coding: utf-8 -*-
1
# -*- coding: utf-8 -*-
1916
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
1917
3
3
1936
4
###############################################################################
4
##########################################################################
1937
5
# OpenLP - Open Source Lyrics Projection                                      #
5
# OpenLP - Open Source Lyrics Projection                                 #
1938
6
# --------------------------------------------------------------------------- #
6
# ---------------------------------------------------------------------- #
1939
7
# Copyright (c) 2008-2019 OpenLP Developers                                   #
7
# Copyright (c) 2008-2019 OpenLP Developers                              #
1940
8
# --------------------------------------------------------------------------- #
8
# ---------------------------------------------------------------------- #
1941
9
# This program is free software; you can redistribute it and/or modify it     #
9
# This program is free software: you can redistribute it and/or modify   #
1942
10
# under the terms of the GNU General Public License as published by the Free  #
10
# it under the terms of the GNU General Public License as published by   #
1943
11
# Software Foundation; version 2 of the License.                              #
11
# the Free Software Foundation, either version 3 of the License, or      #
1944
12
#                                                                             #
12
# (at your option) any later version.                                    #
1945
13
# This program is distributed in the hope that it will be useful, but WITHOUT #
13
#                                                                        #
1946
14
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
14
# This program is distributed in the hope that it will be useful,        #
1947
15
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
15
# but WITHOUT ANY WARRANTY; without even the implied warranty of         #
1948
16
# more details.                                                               #
16
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          #
1949
17
#                                                                             #
17
# GNU General Public License for more details.                           #
1950
18
# You should have received a copy of the GNU General Public License along     #
18
#                                                                        #
1951
19
# with this program; if not, write to the Free Software Foundation, Inc., 59  #
19
# You should have received a copy of the GNU General Public License      #
1952
20
# Temple Place, Suite 330, Boston, MA 02111-1307 USA                          #
20
# along with this program.  If not, see <https://www.gnu.org/licenses/>. #
1953
21
###############################################################################
21
##########################################################################
1954
22
"""
22
"""
1955
23
The :mod:`~openlp.core.api.tab` module contains the settings tab for the API
23
The :mod:`~openlp.core.api.tab` module contains the settings tab for the API
1956
24
"""
24
"""
1957
25
25
1958
=== modified file 'openlp/core/api/websockets.py'
1959
--- openlp/core/api/websockets.py	2019-02-14 15:09:09 +0000
1960
+++ openlp/core/api/websockets.py	2019-07-01 17:47:01 +0000
1961
@@ -1,24 +1,24 @@
1962
1
# -*- coding: utf-8 -*-
1
# -*- coding: utf-8 -*-
1963
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
1964
3
3
1983
4
###############################################################################
4
##########################################################################
1984
5
# OpenLP - Open Source Lyrics Projection                                      #
5
# OpenLP - Open Source Lyrics Projection                                 #
1985
6
# --------------------------------------------------------------------------- #
6
# ---------------------------------------------------------------------- #
1986
7
# Copyright (c) 2008-2019 OpenLP Developers                                   #
7
# Copyright (c) 2008-2019 OpenLP Developers                              #
1987
8
# --------------------------------------------------------------------------- #
8
# ---------------------------------------------------------------------- #
1988
9
# This program is free software; you can redistribute it and/or modify it     #
9
# This program is free software: you can redistribute it and/or modify   #
1989
10
# under the terms of the GNU General Public License as published by the Free  #
10
# it under the terms of the GNU General Public License as published by   #
1990
11
# Software Foundation; version 2 of the License.                              #
11
# the Free Software Foundation, either version 3 of the License, or      #
1991
12
#                                                                             #
12
# (at your option) any later version.                                    #
1992
13
# This program is distributed in the hope that it will be useful, but WITHOUT #
13
#                                                                        #
1993
14
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
14
# This program is distributed in the hope that it will be useful,        #
1994
15
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
15
# but WITHOUT ANY WARRANTY; without even the implied warranty of         #
1995
16
# more details.                                                               #
16
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          #
1996
17
#                                                                             #
17
# GNU General Public License for more details.                           #
1997
18
# You should have received a copy of the GNU General Public License along     #
18
#                                                                        #
1998
19
# with this program; if not, write to the Free Software Foundation, Inc., 59  #
19
# You should have received a copy of the GNU General Public License      #
1999
20
# Temple Place, Suite 330, Boston, MA 02111-1307 USA                          #
20
# along with this program.  If not, see <https://www.gnu.org/licenses/>. #
2000
21
###############################################################################
21
##########################################################################
2001
22
"""
22
"""
2002
23
The :mod:`http` module contains the API web server. This is a lightweight web server used by remotes to interact
23
The :mod:`http` module contains the API web server. This is a lightweight web server used by remotes to interact
2003
24
with OpenLP. It uses JSON to communicate with the remotes.
24
with OpenLP. It uses JSON to communicate with the remotes.
2004
25
25
2005
=== modified file 'openlp/core/app.py'
2006
--- openlp/core/app.py	2019-02-14 15:09:09 +0000
2007
+++ openlp/core/app.py	2019-07-01 17:47:01 +0000
2008
@@ -1,24 +1,24 @@
2009
1
# -*- coding: utf-8 -*-
1
# -*- coding: utf-8 -*-
2010
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
2011
3
3
2030
4
###############################################################################
4
##########################################################################
2031
5
# OpenLP - Open Source Lyrics Projection                                      #
5
# OpenLP - Open Source Lyrics Projection                                 #
2032
6
# --------------------------------------------------------------------------- #
6
# ---------------------------------------------------------------------- #
2033
7
# Copyright (c) 2008-2019 OpenLP Developers                                   #
7
# Copyright (c) 2008-2019 OpenLP Developers                              #
2034
8
# --------------------------------------------------------------------------- #
8
# ---------------------------------------------------------------------- #
2035
9
# This program is free software; you can redistribute it and/or modify it     #
9
# This program is free software: you can redistribute it and/or modify   #
2036
10
# under the terms of the GNU General Public License as published by the Free  #
10
# it under the terms of the GNU General Public License as published by   #
2037
11
# Software Foundation; version 2 of the License.                              #
11
# the Free Software Foundation, either version 3 of the License, or      #
2038
12
#                                                                             #
12
# (at your option) any later version.                                    #
2039
13
# This program is distributed in the hope that it will be useful, but WITHOUT #
13
#                                                                        #
2040
14
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
14
# This program is distributed in the hope that it will be useful,        #
2041
15
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
15
# but WITHOUT ANY WARRANTY; without even the implied warranty of         #
2042
16
# more details.                                                               #
16
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          #
2043
17
#                                                                             #
17
# GNU General Public License for more details.                           #
2044
18
# You should have received a copy of the GNU General Public License along     #
18
#                                                                        #
2045
19
# with this program; if not, write to the Free Software Foundation, Inc., 59  #
19
# You should have received a copy of the GNU General Public License      #
2046
20
# Temple Place, Suite 330, Boston, MA 02111-1307 USA                          #
20
# along with this program.  If not, see <https://www.gnu.org/licenses/>. #
2047
21
###############################################################################
21
##########################################################################
2048
22
22
2049
23
"""
23
"""
2050
24
The :mod:`core` module provides all core application functions
24
The :mod:`core` module provides all core application functions
2051
@@ -28,9 +28,12 @@
2052
28
"""
28
"""
2053
29
import argparse
29
import argparse
2054
30
import logging
30
import logging
2055
31
import os
2056
31
import sys
32
import sys
2057
32
import time
33
import time
2058
33
from datetime import datetime
34
from datetime import datetime
2059
35
from pathlib import Path
2060
36
from shutil import copytree
2061
34
from traceback import format_exception
37
from traceback import format_exception
2062
35
38
2063
36
from PyQt5 import QtCore, QtWebEngineWidgets, QtWidgets  # noqa
39
from PyQt5 import QtCore, QtWebEngineWidgets, QtWidgets  # noqa
2064
@@ -40,7 +43,7 @@
2065
40
from openlp.core.common.applocation import AppLocation
43
from openlp.core.common.applocation import AppLocation
2066
41
from openlp.core.loader import loader
44
from openlp.core.loader import loader
2067
42
from openlp.core.common.i18n import LanguageManager, UiStrings, translate
45
from openlp.core.common.i18n import LanguageManager, UiStrings, translate
2069
43
from openlp.core.common.path import copytree, create_paths
46
from openlp.core.common.path import create_paths
2070
44
from openlp.core.common.registry import Registry
47
from openlp.core.common.registry import Registry
2071
45
from openlp.core.common.settings import Settings
48
from openlp.core.common.settings import Settings
2072
46
from openlp.core.display.screens import ScreenList
49
from openlp.core.display.screens import ScreenList
2073
@@ -101,7 +104,7 @@
2074
101
            ftw.initialize(screens)
104
            ftw.initialize(screens)
2075
102
            if ftw.exec() == QtWidgets.QDialog.Accepted:
105
            if ftw.exec() == QtWidgets.QDialog.Accepted:
2076
103
                Settings().setValue('core/has run wizard', True)
106
                Settings().setValue('core/has run wizard', True)
2078
104
            elif ftw.was_cancelled:
107
            else:
2079
105
                QtCore.QCoreApplication.exit()
108
                QtCore.QCoreApplication.exit()
2080
106
                sys.exit()
109
                sys.exit()
2081
107
        # Correct stylesheet bugs
110
        # Correct stylesheet bugs
2082
@@ -286,12 +289,12 @@
2083
286
        return QtWidgets.QApplication.event(self, event)
289
        return QtWidgets.QApplication.event(self, event)
2084
287
290
2085
288
291
2087
289
def parse_options(args=None):
292
def parse_options():
2088
290
    """
293
    """
2089
291
    Parse the command line arguments
294
    Parse the command line arguments
2090
292
295
2093
293
    :param args: list of command line arguments
296
    :return: An :object:`argparse.Namespace` insatnce containing the parsed args.
2094
294
    :return: a tuple of parsed options of type optparse.Value and a list of remaining argsZ
297
    :rtype: argparse.Namespace
2095
295
    """
298
    """
2096
296
    # Set up command line options.
299
    # Set up command line options.
2097
297
    parser = argparse.ArgumentParser(prog='openlp')
300
    parser = argparse.ArgumentParser(prog='openlp')
2098
@@ -301,37 +304,37 @@
2099
301
                        help='Set logging to LEVEL level. Valid values are "debug", "info", "warning".')
304
                        help='Set logging to LEVEL level. Valid values are "debug", "info", "warning".')
2100
302
    parser.add_argument('-p', '--portable', dest='portable', action='store_true',
305
    parser.add_argument('-p', '--portable', dest='portable', action='store_true',
2101
303
                        help='Specify if this should be run as a portable app, ')
306
                        help='Specify if this should be run as a portable app, ')
2102
307
    parser.add_argument('-pp', '--portable-path', dest='portablepath', default=None,
2103
308
                        help='Specify the path of the portable data, defaults to "{dir_name}".'.format(
2104
309
                            dir_name=os.path.join('<AppDir>', '..', '..')))
2105
304
    parser.add_argument('-w', '--no-web-server', dest='no_web_server', action='store_true',
310
    parser.add_argument('-w', '--no-web-server', dest='no_web_server', action='store_true',
2106
305
                        help='Turn off the Web and Socket Server ')
311
                        help='Turn off the Web and Socket Server ')
2110
306
    parser.add_argument('rargs', nargs='?', default=[])
312
    parser.add_argument('rargs', nargs='*', default=[])
2111
307
    # Parse command line options and deal with them. Use args supplied pragmatically if possible.
313
    # Parse command line options and deal with them.
2112
308
    return parser.parse_args(args) if args else parser.parse_args()
314
    return parser.parse_args()
2113
309
315
2114
310
316
2115
311
def set_up_logging(log_path):
317
def set_up_logging(log_path):
2116
312
    """
318
    """
2117
313
    Setup our logging using log_path
319
    Setup our logging using log_path
2118
314
320
2120
315
    :param openlp.core.common.path.Path log_path: The file to save the log to.
321
    :param Path log_path: The file to save the log to.
2121
316
    :rtype: None
322
    :rtype: None
2122
317
    """
323
    """
2123
318
    create_paths(log_path, do_not_log=True)
324
    create_paths(log_path, do_not_log=True)
2124
319
    file_path = log_path / 'openlp.log'
325
    file_path = log_path / 'openlp.log'
2127
320
    # TODO: FileHandler accepts a Path object in Py3.6
326
    logfile = logging.FileHandler(file_path, 'w', encoding='UTF-8')
2126
321
    logfile = logging.FileHandler(str(file_path), 'w', encoding='UTF-8')
2128
322
    logfile.setFormatter(logging.Formatter('%(asctime)s %(threadName)s %(name)-55s %(levelname)-8s %(message)s'))
327
    logfile.setFormatter(logging.Formatter('%(asctime)s %(threadName)s %(name)-55s %(levelname)-8s %(message)s'))
2129
323
    log.addHandler(logfile)
328
    log.addHandler(logfile)
2130
324
    if log.isEnabledFor(logging.DEBUG):
329
    if log.isEnabledFor(logging.DEBUG):
2131
325
        print('Logging to: {name}'.format(name=file_path))
330
        print('Logging to: {name}'.format(name=file_path))
2132
326
331
2133
327
332
2135
328
def main(args=None):
333
def main():
2136
329
    """
334
    """
2137
330
    The main function which parses command line options and then runs
335
    The main function which parses command line options and then runs
2138
331
2139
332
    :param args: Some args
2140
333
    """
336
    """
2142
334
    args = parse_options(args)
337
    args = parse_options()
2143
335
    qt_args = ['--disable-web-security']
338
    qt_args = ['--disable-web-security']
2144
336
    # qt_args = []
339
    # qt_args = []
2145
337
    if args and args.loglevel.lower() in ['d', 'debug']:
340
    if args and args.loglevel.lower() in ['d', 'debug']:
2146
@@ -357,14 +360,21 @@
2147
357
        application.setApplicationName('OpenLPPortable')
360
        application.setApplicationName('OpenLPPortable')
2148
358
        Settings.setDefaultFormat(Settings.IniFormat)
361
        Settings.setDefaultFormat(Settings.IniFormat)
2149
359
        # Get location OpenLPPortable.ini
362
        # Get location OpenLPPortable.ini
2151
360
        portable_path = (AppLocation.get_directory(AppLocation.AppDir) / '..' / '..').resolve()
363
        if args.portablepath:
2152
364
            if os.path.isabs(args.portablepath):
2153
365
                portable_path = Path(args.portablepath)
2154
366
            else:
2155
367
                portable_path = AppLocation.get_directory(AppLocation.AppDir) / '..' / args.portablepath
2156
368
        else:
2157
369
            portable_path = AppLocation.get_directory(AppLocation.AppDir) / '..' / '..'
2158
370
        portable_path = portable_path.resolve()
2159
361
        data_path = portable_path / 'Data'
371
        data_path = portable_path / 'Data'
2160
362
        set_up_logging(portable_path / 'Other')
372
        set_up_logging(portable_path / 'Other')
2161
363
        log.info('Running portable')
373
        log.info('Running portable')
2162
364
        portable_settings_path = data_path / 'OpenLP.ini'
374
        portable_settings_path = data_path / 'OpenLP.ini'
2163
365
        # Make this our settings file
375
        # Make this our settings file
2164
366
        log.info('INI file: {name}'.format(name=portable_settings_path))
376
        log.info('INI file: {name}'.format(name=portable_settings_path))
2166
367
        Settings.set_filename(str(portable_settings_path))
377
        Settings.set_filename(portable_settings_path)
2167
368
        portable_settings = Settings()
378
        portable_settings = Settings()
2168
369
        # Set our data path
379
        # Set our data path
2169
370
        log.info('Data path: {name}'.format(name=data_path))
380
        log.info('Data path: {name}'.format(name=data_path))
2170
@@ -375,6 +385,15 @@
2171
375
    else:
385
    else:
2172
376
        application.setApplicationName('OpenLP')
386
        application.setApplicationName('OpenLP')
2173
377
        set_up_logging(AppLocation.get_directory(AppLocation.CacheDir))
387
        set_up_logging(AppLocation.get_directory(AppLocation.CacheDir))
2174
388
    # Set the libvlc environment variable if we're frozen
2175
389
    if getattr(sys, 'frozen', False):
2176
390
        if is_macosx():
2177
391
            vlc_lib = 'libvlc.dylib'
2178
392
        elif is_win():
2179
393
            vlc_lib = 'libvlc.dll'
2180
394
        os.environ['PYTHON_VLC_LIB_PATH'] = str(AppLocation.get_directory(AppLocation.AppDir) / vlc_lib)
2181
395
        log.debug('VLC Path: {}'.format(os.environ['PYTHON_VLC_LIB_PATH']))
2182
396
    # Initialise the Registry
2183
378
    Registry.create()
397
    Registry.create()
2184
379
    Registry().register('application', application)
398
    Registry().register('application', application)
2185
380
    Registry().set_flag('no_web_server', args.no_web_server)
399
    Registry().set_flag('no_web_server', args.no_web_server)
2186
@@ -405,7 +424,12 @@
2187
405
                None, translate('OpenLP', 'Settings Upgrade'),
424
                None, translate('OpenLP', 'Settings Upgrade'),
2188
406
                translate('OpenLP', 'Your settings are about to be upgraded. A backup will be created at '
425
                translate('OpenLP', 'Your settings are about to be upgraded. A backup will be created at '
2189
407
                                    '{back_up_path}').format(back_up_path=back_up_path))
426
                                    '{back_up_path}').format(back_up_path=back_up_path))
2191
408
            settings.export(back_up_path)
427
            try:
2192
428
                settings.export(back_up_path)
2193
429
            except OSError:
2194
430
                QtWidgets.QMessageBox.warning(
2195
431
                    None, translate('OpenLP', 'Settings Upgrade'),
2196
432
                    translate('OpenLP', 'Settings back up failed.\n\nContinuining to upgrade.'))
2197
409
        settings.upgrade_settings()
433
        settings.upgrade_settings()
2198
410
    # First time checks in settings
434
    # First time checks in settings
2199
411
    if not Settings().value('core/has run wizard'):
435
    if not Settings().value('core/has run wizard'):
2200
412
436
2201
=== modified file 'openlp/core/common/__init__.py'
2202
--- openlp/core/common/__init__.py	2019-02-14 15:09:09 +0000
2203
+++ openlp/core/common/__init__.py	2019-07-01 17:47:01 +0000
2204
@@ -1,24 +1,24 @@
2205
1
# -*- coding: utf-8 -*-
1
# -*- coding: utf-8 -*-
2206
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
2207
3
3
2226
4
###############################################################################
4
##########################################################################
2227
5
# OpenLP - Open Source Lyrics Projection                                      #
5
# OpenLP - Open Source Lyrics Projection                                 #
2228
6
# --------------------------------------------------------------------------- #
6
# ---------------------------------------------------------------------- #
2229
7
# Copyright (c) 2008-2019 OpenLP Developers                                   #
7
# Copyright (c) 2008-2019 OpenLP Developers                              #
2230
8
# --------------------------------------------------------------------------- #
8
# ---------------------------------------------------------------------- #
2231
9
# This program is free software; you can redistribute it and/or modify it     #
9
# This program is free software: you can redistribute it and/or modify   #
2232
10
# under the terms of the GNU General Public License as published by the Free  #
10
# it under the terms of the GNU General Public License as published by   #
2233
11
# Software Foundation; version 2 of the License.                              #
11
# the Free Software Foundation, either version 3 of the License, or      #
2234
12
#                                                                             #
12
# (at your option) any later version.                                    #
2235
13
# This program is distributed in the hope that it will be useful, but WITHOUT #
13
#                                                                        #
2236
14
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
14
# This program is distributed in the hope that it will be useful,        #
2237
15
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
15
# but WITHOUT ANY WARRANTY; without even the implied warranty of         #
2238
16
# more details.                                                               #
16
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          #
2239
17
#                                                                             #
17
# GNU General Public License for more details.                           #
2240
18
# You should have received a copy of the GNU General Public License along     #
18
#                                                                        #
2241
19
# with this program; if not, write to the Free Software Foundation, Inc., 59  #
19
# You should have received a copy of the GNU General Public License      #
2242
20
# Temple Place, Suite 330, Boston, MA 02111-1307 USA                          #
20
# along with this program.  If not, see <https://www.gnu.org/licenses/>. #
2243
21
###############################################################################
21
##########################################################################
2244
22
"""
22
"""
2245
23
The :mod:`common` module contains most of the components and libraries that make
23
The :mod:`common` module contains most of the components and libraries that make
2246
24
OpenLP work.
24
OpenLP work.
2247
@@ -134,15 +134,15 @@
2248
134
            importlib.import_module(module_name)
134
            importlib.import_module(module_name)
2249
135
        except (ImportError, OSError):
135
        except (ImportError, OSError):
2250
136
            # On some platforms importing vlc.py might cause OSError exceptions. (e.g. Mac OS X)
136
            # On some platforms importing vlc.py might cause OSError exceptions. (e.g. Mac OS X)
2253
137
            log.warning('Failed to import {module_name} on path {extension_path}'
137
            log.exception('Failed to import {module_name} on path {extension_path}'
2254
138
                        .format(module_name=module_name, extension_path=extension_path))
138
                          .format(module_name=module_name, extension_path=extension_path))
2255
139
139
2256
140
140
2257
141
def path_to_module(path):
141
def path_to_module(path):
2258
142
    """
142
    """
2259
143
    Convert a path to a module name (i.e openlp.core.common)
143
    Convert a path to a module name (i.e openlp.core.common)
2260
144
144
2262
145
    :param openlp.core.common.path.Path path: The path to convert to a module name.
145
    :param pathlib.Path path: The path to convert to a module name.
2263
146
    :return: The module name.
146
    :return: The module name.
2264
147
    :rtype: str
147
    :rtype: str
2265
148
    """
148
    """
2266
@@ -371,7 +371,7 @@
2267
371
    """
371
    """
2268
372
    Deletes a file from the system.
372
    Deletes a file from the system.
2269
373
373
2271
374
    :param openlp.core.common.path.Path file_path: The file, including path, to delete.
374
    :param pathlib.Path file_path: The file, including path, to delete.
2272
375
    :return: True if the deletion was successful, or the file never existed. False otherwise.
375
    :return: True if the deletion was successful, or the file never existed. False otherwise.
2273
376
    :rtype: bool
376
    :rtype: bool
2274
377
    """
377
    """
2275
@@ -407,7 +407,7 @@
2276
407
    """
407
    """
2277
408
    Validate that the file is not an image file.
408
    Validate that the file is not an image file.
2278
409
409
2280
410
    :param openlp.core.common.path.Path file_path: The file to be checked.
410
    :param pathlib.Path file_path: The file to be checked.
2281
411
    :return: If the file is not an image
411
    :return: If the file is not an image
2282
412
    :rtype: bool
412
    :rtype: bool
2283
413
    """
413
    """
2284
@@ -435,7 +435,7 @@
2285
435
    """
435
    """
2286
436
    Function that checks whether a binary exists.
436
    Function that checks whether a binary exists.
2287
437
437
2289
438
    :param openlp.core.common.path.Path program_path: The full path to the binary to check.
438
    :param pathlib.Path program_path: The full path to the binary to check.
2290
439
    :return: program output to be parsed
439
    :return: program output to be parsed
2291
440
    :rtype: bytes
440
    :rtype: bytes
2292
441
    """
441
    """
2293
@@ -462,9 +462,9 @@
2294
462
    """
462
    """
2295
463
    Utility function to incrementally detect the file encoding.
463
    Utility function to incrementally detect the file encoding.
2296
464
464
2300
465
    :param openlp.core.common.path.Path file_path: Filename for the file to determine the encoding for.
465
    :param pathlib.Path file_path: Filename for the file to determine the encoding for.
2301
466
    :return: A dict with the keys 'encoding' and 'confidence'
466
    :return: The name of the encoding detected
2302
467
    :rtype: dict[str, float]
467
    :rtype: str
2303
468
    """
468
    """
2304
469
    detector = UniversalDetector()
469
    detector = UniversalDetector()
2305
470
    try:
470
    try:
2306
@@ -474,10 +474,10 @@
2307
474
                if not chunk:
474
                if not chunk:
2308
475
                    break
475
                    break
2309
476
                detector.feed(chunk)
476
                detector.feed(chunk)
2310
477
            detector.close()
2311
478
        return detector.result
2312
479
    except OSError:
477
    except OSError:
2313
480
        log.exception('Error detecting file encoding')
478
        log.exception('Error detecting file encoding')
2314
479
    finally:
2315
480
        return detector.close()['encoding']
2316
481
481
2317
482
482
2318
483
def normalize_str(irregular_string):
483
def normalize_str(irregular_string):
2319
484
484
2320
=== modified file 'openlp/core/common/actions.py'
2321
--- openlp/core/common/actions.py	2019-02-14 15:09:09 +0000
2322
+++ openlp/core/common/actions.py	2019-07-01 17:47:01 +0000
2323
@@ -1,24 +1,24 @@
2324
1
# -*- coding: utf-8 -*-
1
# -*- coding: utf-8 -*-
2325
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
2326
3
3
2345
4
###############################################################################
4
##########################################################################
2346
5
# OpenLP - Open Source Lyrics Projection                                      #
5
# OpenLP - Open Source Lyrics Projection                                 #
2347
6
# --------------------------------------------------------------------------- #
6
# ---------------------------------------------------------------------- #
2348
7
# Copyright (c) 2008-2019 OpenLP Developers                                   #
7
# Copyright (c) 2008-2019 OpenLP Developers                              #
2349
8
# --------------------------------------------------------------------------- #
8
# ---------------------------------------------------------------------- #
2350
9
# This program is free software; you can redistribute it and/or modify it     #
9
# This program is free software: you can redistribute it and/or modify   #
2351
10
# under the terms of the GNU General Public License as published by the Free  #
10
# it under the terms of the GNU General Public License as published by   #
2352
11
# Software Foundation; version 2 of the License.                              #
11
# the Free Software Foundation, either version 3 of the License, or      #
2353
12
#                                                                             #
12
# (at your option) any later version.                                    #
2354
13
# This program is distributed in the hope that it will be useful, but WITHOUT #
13
#                                                                        #
2355
14
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
14
# This program is distributed in the hope that it will be useful,        #
2356
15
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
15
# but WITHOUT ANY WARRANTY; without even the implied warranty of         #
2357
16
# more details.                                                               #
16
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          #
2358
17
#                                                                             #
17
# GNU General Public License for more details.                           #
2359
18
# You should have received a copy of the GNU General Public License along     #
18
#                                                                        #
2360
19
# with this program; if not, write to the Free Software Foundation, Inc., 59  #
19
# You should have received a copy of the GNU General Public License      #
2361
20
# Temple Place, Suite 330, Boston, MA 02111-1307 USA                          #
20
# along with this program.  If not, see <https://www.gnu.org/licenses/>. #
2362
21
###############################################################################
21
##########################################################################
2363
22
"""
22
"""
2364
23
The :mod:`~openlp.core.common.actions` module provides action list classes used
23
The :mod:`~openlp.core.common.actions` module provides action list classes used
2365
24
by the shortcuts system.
24
by the shortcuts system.
2366
25
25
2367
=== modified file 'openlp/core/common/applocation.py'
2368
--- openlp/core/common/applocation.py	2019-02-14 15:09:09 +0000
2369
+++ openlp/core/common/applocation.py	2019-07-01 17:47:01 +0000
2370
@@ -1,36 +1,37 @@
2371
1
# -*- coding: utf-8 -*-
1
# -*- coding: utf-8 -*-
2372
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
2373
3
3
2392
4
###############################################################################
4
##########################################################################
2393
5
# OpenLP - Open Source Lyrics Projection                                      #
5
# OpenLP - Open Source Lyrics Projection                                 #
2394
6
# --------------------------------------------------------------------------- #
6
# ---------------------------------------------------------------------- #
2395
7
# Copyright (c) 2008-2019 OpenLP Developers                                   #
7
# Copyright (c) 2008-2019 OpenLP Developers                              #
2396
8
# --------------------------------------------------------------------------- #
8
# ---------------------------------------------------------------------- #
2397
9
# This program is free software; you can redistribute it and/or modify it     #
9
# This program is free software: you can redistribute it and/or modify   #
2398
10
# under the terms of the GNU General Public License as published by the Free  #
10
# it under the terms of the GNU General Public License as published by   #
2399
11
# Software Foundation; version 2 of the License.                              #
11
# the Free Software Foundation, either version 3 of the License, or      #
2400
12
#                                                                             #
12
# (at your option) any later version.                                    #
2401
13
# This program is distributed in the hope that it will be useful, but WITHOUT #
13
#                                                                        #
2402
14
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
14
# This program is distributed in the hope that it will be useful,        #
2403
15
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
15
# but WITHOUT ANY WARRANTY; without even the implied warranty of         #
2404
16
# more details.                                                               #
16
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          #
2405
17
#                                                                             #
17
# GNU General Public License for more details.                           #
2406
18
# You should have received a copy of the GNU General Public License along     #
18
#                                                                        #
2407
19
# with this program; if not, write to the Free Software Foundation, Inc., 59  #
19
# You should have received a copy of the GNU General Public License      #
2408
20
# Temple Place, Suite 330, Boston, MA 02111-1307 USA                          #
20
# along with this program.  If not, see <https://www.gnu.org/licenses/>. #
2409
21
###############################################################################
21
##########################################################################
2410
22
"""
22
"""
2411
23
The :mod:`openlp.core.common.applocation` module provides an utility for OpenLP receiving the data path etc.
23
The :mod:`openlp.core.common.applocation` module provides an utility for OpenLP receiving the data path etc.
2412
24
"""
24
"""
2413
25
import logging
25
import logging
2414
26
import os
26
import os
2415
27
import sys
27
import sys
2416
28
from pathlib import Path
2417
28
29
2418
29
import appdirs
30
import appdirs
2419
30
31
2420
31
import openlp
32
import openlp
2421
32
from openlp.core.common import get_frozen_path, is_macosx, is_win
33
from openlp.core.common import get_frozen_path, is_macosx, is_win
2423
33
from openlp.core.common.path import Path, create_paths
34
from openlp.core.common.path import create_paths
2424
34
from openlp.core.common.settings import Settings
35
from openlp.core.common.settings import Settings
2425
35
36
2426
36
37
2427
@@ -58,7 +59,7 @@
2428
58
59
2429
59
        :param dir_type: The directory type you want, for instance the data directory. Default *AppLocation.AppDir*
60
        :param dir_type: The directory type you want, for instance the data directory. Default *AppLocation.AppDir*
2430
60
        :return: The requested path
61
        :return: The requested path
2432
61
        :rtype: openlp.core.common.path.Path
62
        :rtype: Path
2433
62
        """
63
        """
2434
63
        if dir_type == AppLocation.AppDir or dir_type == AppLocation.VersionDir:
64
        if dir_type == AppLocation.AppDir or dir_type == AppLocation.VersionDir:
2435
64
            return get_frozen_path(FROZEN_APP_PATH, APP_PATH)
65
            return get_frozen_path(FROZEN_APP_PATH, APP_PATH)
2436
@@ -75,7 +76,7 @@
2437
75
        Return the path OpenLP stores all its data under.
76
        Return the path OpenLP stores all its data under.
2438
76
77
2439
77
        :return: The data path to use.
78
        :return: The data path to use.
2441
78
        :rtype: openlp.core.common.path.Path
79
        :rtype: Path
2442
79
        """
80
        """
2443
80
        # Check if we have a different data location.
81
        # Check if we have a different data location.
2444
81
        if Settings().contains('advanced/data path'):
82
        if Settings().contains('advanced/data path'):
2445
@@ -95,7 +96,7 @@
2446
95
        :param str extension: Defaults to ''. The extension to search for. For example::
96
        :param str extension: Defaults to ''. The extension to search for. For example::
2447
96
            '.png'
97
            '.png'
2448
97
        :return: List of files found.
98
        :return: List of files found.
2450
98
        :rtype: list[openlp.core.common.path.Path]
99
        :rtype: list[Path]
2451
99
        """
100
        """
2452
100
        path = AppLocation.get_data_path()
101
        path = AppLocation.get_data_path()
2453
101
        if section:
102
        if section:
2454
@@ -112,7 +113,7 @@
2455
112
        Return the path a particular module stores its data under.
113
        Return the path a particular module stores its data under.
2456
113
114
2457
114
        :param str section:
115
        :param str section:
2459
115
        :rtype: openlp.core.common.path.Path
116
        :rtype: Path
2460
116
        """
117
        """
2461
117
        path = AppLocation.get_data_path() / section
118
        path = AppLocation.get_data_path() / section
2462
118
        create_paths(path)
119
        create_paths(path)
2463
@@ -125,7 +126,7 @@
2464
125
126
2465
126
    :param dir_type: AppLocation Enum of the requested path type
127
    :param dir_type: AppLocation Enum of the requested path type
2466
127
    :return: The requested path
128
    :return: The requested path
2468
128
    :rtype: openlp.core.common.path.Path
129
    :rtype: Path
2469
129
    """
130
    """
2470
130
    # If running from source, return the language directory from the source directory
131
    # If running from source, return the language directory from the source directory
2471
131
    if dir_type == AppLocation.LanguageDir:
132
    if dir_type == AppLocation.LanguageDir:
2472
132
133
2473
=== modified file 'openlp/core/common/db.py'
2474
--- openlp/core/common/db.py	2019-02-14 15:09:09 +0000
2475
+++ openlp/core/common/db.py	2019-07-01 17:47:01 +0000
2476
@@ -1,24 +1,24 @@
2477
1
# -*- coding: utf-8 -*-
1
# -*- coding: utf-8 -*-
2478
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
2479
3
3
2498
4
###############################################################################
4
##########################################################################
2499
5
# OpenLP - Open Source Lyrics Projection                                      #
5
# OpenLP - Open Source Lyrics Projection                                 #
2500
6
# --------------------------------------------------------------------------- #
6
# ---------------------------------------------------------------------- #
2501
7
# Copyright (c) 2008-2019 OpenLP Developers                                   #
7
# Copyright (c) 2008-2019 OpenLP Developers                              #
2502
8
# --------------------------------------------------------------------------- #
8
# ---------------------------------------------------------------------- #
2503
9
# This program is free software; you can redistribute it and/or modify it     #
9
# This program is free software: you can redistribute it and/or modify   #
2504
10
# under the terms of the GNU General Public License as published by the Free  #
10
# it under the terms of the GNU General Public License as published by   #
2505
11
# Software Foundation; version 2 of the License.                              #
11
# the Free Software Foundation, either version 3 of the License, or      #
2506
12
#                                                                             #
12
# (at your option) any later version.                                    #
2507
13
# This program is distributed in the hope that it will be useful, but WITHOUT #
13
#                                                                        #
2508
14
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
14
# This program is distributed in the hope that it will be useful,        #
2509
15
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
15
# but WITHOUT ANY WARRANTY; without even the implied warranty of         #
2510
16
# more details.                                                               #
16
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          #
2511
17
#                                                                             #
17
# GNU General Public License for more details.                           #
2512
18
# You should have received a copy of the GNU General Public License along     #
18
#                                                                        #
2513
19
# with this program; if not, write to the Free Software Foundation, Inc., 59  #
19
# You should have received a copy of the GNU General Public License      #
2514
20
# Temple Place, Suite 330, Boston, MA 02111-1307 USA                          #
20
# along with this program.  If not, see <https://www.gnu.org/licenses/>. #
2515
21
###############################################################################
21
##########################################################################
2516
22
"""
22
"""
2517
23
The :mod:`db` module provides helper functions for database related methods.
23
The :mod:`db` module provides helper functions for database related methods.
2518
24
"""
24
"""
2519
25
25
2520
=== modified file 'openlp/core/common/httputils.py'
2521
--- openlp/core/common/httputils.py	2019-02-14 15:09:09 +0000
2522
+++ openlp/core/common/httputils.py	2019-07-01 17:47:01 +0000
2523
@@ -1,24 +1,24 @@
2524
1
# -*- coding: utf-8 -*-
1
# -*- coding: utf-8 -*-
2525
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
2526
3
3
2545
4
###############################################################################
4
##########################################################################
2546
5
# OpenLP - Open Source Lyrics Projection                                      #
5
# OpenLP - Open Source Lyrics Projection                                 #
2547
6
# --------------------------------------------------------------------------- #
6
# ---------------------------------------------------------------------- #
2548
7
# Copyright (c) 2008-2019 OpenLP Developers                                   #
7
# Copyright (c) 2008-2019 OpenLP Developers                              #
2549
8
# --------------------------------------------------------------------------- #
8
# ---------------------------------------------------------------------- #
2550
9
# This program is free software; you can redistribute it and/or modify it     #
9
# This program is free software: you can redistribute it and/or modify   #
2551
10
# under the terms of the GNU General Public License as published by the Free  #
10
# it under the terms of the GNU General Public License as published by   #
2552
11
# Software Foundation; version 2 of the License.                              #
11
# the Free Software Foundation, either version 3 of the License, or      #
2553
12
#                                                                             #
12
# (at your option) any later version.                                    #
2554
13
# This program is distributed in the hope that it will be useful, but WITHOUT #
13
#                                                                        #
2555
14
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
14
# This program is distributed in the hope that it will be useful,        #
2556
15
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
15
# but WITHOUT ANY WARRANTY; without even the implied warranty of         #
2557
16
# more details.                                                               #
16
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          #
2558
17
#                                                                             #
17
# GNU General Public License for more details.                           #
2559
18
# You should have received a copy of the GNU General Public License along     #
18
#                                                                        #
2560
19
# with this program; if not, write to the Free Software Foundation, Inc., 59  #
19
# You should have received a copy of the GNU General Public License      #
2561
20
# Temple Place, Suite 330, Boston, MA 02111-1307 USA                          #
20
# along with this program.  If not, see <https://www.gnu.org/licenses/>. #
2562
21
###############################################################################
21
##########################################################################
2563
22
"""
22
"""
2564
23
The :mod:`openlp.core.common.httputils` module provides the utility methods for downloading stuff.
23
The :mod:`openlp.core.common.httputils` module provides the utility methods for downloading stuff.
2565
24
"""
24
"""
2566
@@ -26,13 +26,17 @@
2567
26
import logging
26
import logging
2568
27
import sys
27
import sys
2569
28
import time
28
import time
2570
29
from pathlib import Path
2571
29
from random import randint
30
from random import randint
2572
31
from tempfile import gettempdir
2573
30
32
2574
31
import requests
33
import requests
2575
34
from PyQt5 import QtCore
2576
32
35
2577
33
from openlp.core.common import trace_error_handler
36
from openlp.core.common import trace_error_handler
2578
34
from openlp.core.common.registry import Registry
37
from openlp.core.common.registry import Registry
2579
35
from openlp.core.common.settings import ProxyMode, Settings
38
from openlp.core.common.settings import ProxyMode, Settings
2580
39
from openlp.core.threading import ThreadWorker
2581
36
40
2582
37
41
2583
38
log = logging.getLogger(__name__ + '.__init__')
42
log = logging.getLogger(__name__ + '.__init__')
2584
@@ -154,16 +158,20 @@
2585
154
    return response.text
158
    return response.text
2586
155
159
2587
156
160
2589
157
def get_url_file_size(url):
161
def get_url_file_size(url, proxy=None):
2590
158
    """
162
    """
2591
159
    Get the size of a file.
163
    Get the size of a file.
2592
160
164
2593
161
    :param url: The URL of the file we want to download.
165
    :param url: The URL of the file we want to download.
2594
166
    :param dict | ProxyMode | None proxy: ProxyMode enum or a dictionary containing the proxy servers, with their types
2595
167
        as the key e.g. {'http': 'http://proxyserver:port', 'https': 'https://proxyserver:port'}
2596
162
    """
168
    """
2597
163
    retries = 0
169
    retries = 0
2598
170
    if not isinstance(proxy, dict):
2599
171
        proxy = get_proxy_settings(mode=proxy)
2600
164
    while True:
172
    while True:
2601
165
        try:
173
        try:
2603
166
            response = requests.head(url, timeout=float(CONNECTION_TIMEOUT), allow_redirects=True)
174
            response = requests.head(url, proxies=proxy, timeout=float(CONNECTION_TIMEOUT), allow_redirects=True)
2604
167
            return int(response.headers['Content-Length'])
175
            return int(response.headers['Content-Length'])
2605
168
        except OSError:
176
        except OSError:
2606
169
            if retries > CONNECTION_RETRIES:
177
            if retries > CONNECTION_RETRIES:
2607
@@ -174,7 +182,7 @@
2608
174
                continue
182
                continue
2609
175
183
2610
176
184
2612
177
def download_file(update_object, url, file_path, sha256=None):
185
def download_file(update_object, url, file_path, sha256=None, proxy=None):
2613
178
    """"
186
    """"
2614
179
    Download a file given a URL.  The file is retrieved in chunks, giving the ability to cancel the download at any
187
    Download a file given a URL.  The file is retrieved in chunks, giving the ability to cancel the download at any
2615
180
    point. Returns False on download error.
188
    point. Returns False on download error.
2616
@@ -183,15 +191,19 @@
2617
183
    :param url: URL to download
191
    :param url: URL to download
2618
184
    :param file_path: Destination file
192
    :param file_path: Destination file
2619
185
    :param sha256: The check sum value to be checked against the download value
193
    :param sha256: The check sum value to be checked against the download value
2620
194
    :param dict | ProxyMode | None proxy: ProxyMode enum or a dictionary containing the proxy servers, with their types
2621
195
        as the key e.g. {'http': 'http://proxyserver:port', 'https': 'https://proxyserver:port'}
2622
186
    """
196
    """
2623
187
    block_count = 0
197
    block_count = 0
2624
188
    block_size = 4096
198
    block_size = 4096
2625
189
    retries = 0
199
    retries = 0
2626
200
    if not isinstance(proxy, dict):
2627
201
        proxy = get_proxy_settings(mode=proxy)
2628
190
    log.debug('url_get_file: %s', url)
202
    log.debug('url_get_file: %s', url)
2629
191
    while retries < CONNECTION_RETRIES:
203
    while retries < CONNECTION_RETRIES:
2630
192
        try:
204
        try:
2631
193
            with file_path.open('wb') as saved_file:
205
            with file_path.open('wb') as saved_file:
2633
194
                response = requests.get(url, timeout=float(CONNECTION_TIMEOUT), stream=True)
206
                response = requests.get(url, proxies=proxy, timeout=float(CONNECTION_TIMEOUT), stream=True)
2634
195
                if sha256:
207
                if sha256:
2635
196
                    hasher = hashlib.sha256()
208
                    hasher = hashlib.sha256()
2636
197
                # Download until finished or canceled.
209
                # Download until finished or canceled.
2637
@@ -227,4 +239,46 @@
2638
227
    return True
239
    return True
2639
228
240
2640
229
241
2642
230
__all__ = ['get_web_page']
242
class DownloadWorker(ThreadWorker):
2643
243
    """
2644
244
    This worker allows a file to be downloaded in a thread
2645
245
    """
2646
246
    download_failed = QtCore.pyqtSignal()
2647
247
    download_succeeded = QtCore.pyqtSignal(Path)
2648
248
2649
249
    def __init__(self, base_url, file_name):
2650
250
        """
2651
251
        Set up the worker object
2652
252
        """
2653
253
        self._base_url = base_url
2654
254
        self._file_name = file_name
2655
255
        self.was_cancelled = False
2656
256
        super().__init__()
2657
257
2658
258
    def start(self):
2659
259
        """
2660
260
        Download the url to the temporary directory
2661
261
        """
2662
262
        if self.was_cancelled:
2663
263
            self.quit.emit()
2664
264
            return
2665
265
        try:
2666
266
            dest_path = Path(gettempdir()) / 'openlp' / self._file_name
2667
267
            url = '{url}{name}'.format(url=self._base_url, name=self._file_name)
2668
268
            is_success = download_file(self, url, dest_path)
2669
269
            if is_success and not self.was_cancelled:
2670
270
                self.download_succeeded.emit(dest_path)
2671
271
            else:
2672
272
                self.download_failed.emit()
2673
273
        except Exception:
2674
274
            log.exception('Unable to download %s', url)
2675
275
            self.download_failed.emit()
2676
276
        finally:
2677
277
            self.quit.emit()
2678
278
2679
279
    @QtCore.pyqtSlot()
2680
280
    def cancel_download(self):
2681
281
        """
2682
282
        A slot to allow the download to be cancelled from outside of the thread
2683
283
        """
2684
284
        self.was_cancelled = True
2685
231
285
2686
=== modified file 'openlp/core/common/i18n.py'
2687
--- openlp/core/common/i18n.py	2019-02-14 15:09:09 +0000
2688
+++ openlp/core/common/i18n.py	2019-07-01 17:47:01 +0000
2689
@@ -1,24 +1,24 @@
2690
1
# -*- coding: utf-8 -*-
1
# -*- coding: utf-8 -*-
2691
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
2692
3
3
2711
4
###############################################################################
4
##########################################################################
2712
5
# OpenLP - Open Source Lyrics Projection                                      #
5
# OpenLP - Open Source Lyrics Projection                                 #
2713
6
# --------------------------------------------------------------------------- #
6
# ---------------------------------------------------------------------- #
2714
7
# Copyright (c) 2008-2019 OpenLP Developers                                   #
7
# Copyright (c) 2008-2019 OpenLP Developers                              #
2715
8
# --------------------------------------------------------------------------- #
8
# ---------------------------------------------------------------------- #
2716
9
# This program is free software; you can redistribute it and/or modify it     #
9
# This program is free software: you can redistribute it and/or modify   #
2717
10
# under the terms of the GNU General Public License as published by the Free  #
10
# it under the terms of the GNU General Public License as published by   #
2718
11
# Software Foundation; version 2 of the License.                              #
11
# the Free Software Foundation, either version 3 of the License, or      #
2719
12
#                                                                             #
12
# (at your option) any later version.                                    #
2720
13
# This program is distributed in the hope that it will be useful, but WITHOUT #
13
#                                                                        #
2721
14
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
14
# This program is distributed in the hope that it will be useful,        #
2722
15
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
15
# but WITHOUT ANY WARRANTY; without even the implied warranty of         #
2723
16
# more details.                                                               #
16
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          #
2724
17
#                                                                             #
17
# GNU General Public License for more details.                           #
2725
18
# You should have received a copy of the GNU General Public License along     #
18
#                                                                        #
2726
19
# with this program; if not, write to the Free Software Foundation, Inc., 59  #
19
# You should have received a copy of the GNU General Public License      #
2727
20
# Temple Place, Suite 330, Boston, MA 02111-1307 USA                          #
20
# along with this program.  If not, see <https://www.gnu.org/licenses/>. #
2728
21
###############################################################################
21
##########################################################################
2729
22
"""
22
"""
2730
23
The :mod:`languages` module provides a list of language names with utility functions.
23
The :mod:`languages` module provides a list of language names with utility functions.
2731
24
"""
24
"""
2732
@@ -385,7 +385,8 @@
2733
385
        self.Error = translate('OpenLP.Ui', 'Error')
385
        self.Error = translate('OpenLP.Ui', 'Error')
2734
386
        self.Export = translate('OpenLP.Ui', 'Export')
386
        self.Export = translate('OpenLP.Ui', 'Export')
2735
387
        self.File = translate('OpenLP.Ui', 'File')
387
        self.File = translate('OpenLP.Ui', 'File')
2737
388
        self.FontSizePtUnit = translate('OpenLP.Ui', 'pt', 'Abbreviated font pointsize unit')
388
        self.FileCorrupt = translate('OpenLP.Ui', 'File appears to be corrupt.')
2738
389
        self.FontSizePtUnit = translate('OpenLP.Ui', 'pt', 'Abbreviated font point size unit')
2739
389
        self.Help = translate('OpenLP.Ui', 'Help')
390
        self.Help = translate('OpenLP.Ui', 'Help')
2740
390
        self.Hours = translate('OpenLP.Ui', 'h', 'The abbreviated unit for hours')
391
        self.Hours = translate('OpenLP.Ui', 'h', 'The abbreviated unit for hours')
2741
391
        self.IFdSs = translate('OpenLP.Ui', 'Invalid Folder Selected', 'Singular')
392
        self.IFdSs = translate('OpenLP.Ui', 'Invalid Folder Selected', 'Singular')
2742
392
393
2743
=== modified file 'openlp/core/common/json.py'
2744
--- openlp/core/common/json.py	2019-02-14 15:09:09 +0000
2745
+++ openlp/core/common/json.py	2019-07-01 17:47:01 +0000
2746
@@ -1,32 +1,93 @@
2747
1
# -*- coding: utf-8 -*-
1
# -*- coding: utf-8 -*-
2748
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
2749
3
3
2768
4
###############################################################################
4
##########################################################################
2769
5
# OpenLP - Open Source Lyrics Projection                                      #
5
# OpenLP - Open Source Lyrics Projection                                 #
2770
6
# --------------------------------------------------------------------------- #
6
# ---------------------------------------------------------------------- #
2771
7
# Copyright (c) 2008-2019 OpenLP Developers                                   #
7
# Copyright (c) 2008-2019 OpenLP Developers                              #
2772
8
# --------------------------------------------------------------------------- #
8
# ---------------------------------------------------------------------- #
2773
9
# This program is free software; you can redistribute it and/or modify it     #
9
# This program is free software: you can redistribute it and/or modify   #
2774
10
# under the terms of the GNU General Public License as published by the Free  #
10
# it under the terms of the GNU General Public License as published by   #
2775
11
# Software Foundation; version 2 of the License.                              #
11
# the Free Software Foundation, either version 3 of the License, or      #
2776
12
#                                                                             #
12
# (at your option) any later version.                                    #
2777
13
# This program is distributed in the hope that it will be useful, but WITHOUT #
13
#                                                                        #
2778
14
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
14
# This program is distributed in the hope that it will be useful,        #
2779
15
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
15
# but WITHOUT ANY WARRANTY; without even the implied warranty of         #
2780
16
# more details.                                                               #
16
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          #
2781
17
#                                                                             #
17
# GNU General Public License for more details.                           #
2782
18
# You should have received a copy of the GNU General Public License along     #
18
#                                                                        #
2783
19
# with this program; if not, write to the Free Software Foundation, Inc., 59  #
19
# You should have received a copy of the GNU General Public License      #
2784
20
# Temple Place, Suite 330, Boston, MA 02111-1307 USA                          #
20
# along with this program.  If not, see <https://www.gnu.org/licenses/>. #
2785
21
###############################################################################
21
##########################################################################
2786
22
from contextlib import suppress
2787
22
from json import JSONDecoder, JSONEncoder
23
from json import JSONDecoder, JSONEncoder
2795
23
24
from pathlib import Path
2796
24
from openlp.core.common.path import Path
25
2797
25
26
_registered_classes = {}
2798
26
27
2799
27
class OpenLPJsonDecoder(JSONDecoder):
28
2800
28
    """
29
class JSONMixin(object):
2801
29
    Implement a custom JSONDecoder to handle Path objects
30
    """
2802
31
    :class:`JSONMixin` is a mixin class to simplify the serialization of a subclass to JSON.
2803
32
2804
33
    :cvar:`_json_keys` is used to specify the attributes of the subclass that you wish to serialize.
2805
34
    :vartype _json_keys: list[str]
2806
35
    :cvar:`_name` set to override the the subclass name, useful if using a `proxy` class
2807
36
    :vartype _name: str
2808
37
    """
2809
38
    _json_keys = []
2810
39
    _name = None
2811
40
    _version = 1
2812
41
2813
42
    def __init_subclass__(cls, register_names=None, **kwargs):
2814
43
        """
2815
44
        Register the subclass.
2816
45
2817
46
        :param collections.Iterable[str] register_names: Alternative names to register instead of the class name
2818
47
        :param kwargs: Other args to pass to the super method
2819
48
        :return None:
2820
49
        """
2821
50
        super().__init_subclass__(**kwargs)
2822
51
        for key in register_names or [cls.__name__]:
2823
52
            _registered_classes[key] = cls
2824
53
2825
54
    @classmethod
2826
55
    def encode_json(cls, obj, **kwargs):
2827
56
        """
2828
57
        Create a instance of the subclass from the dictionary that has been constructed by the JSON representation.
2829
58
        Only use the keys specified in :cvar:`_json_keys`.
2830
59
2831
60
        :param dict[str] obj: The dictionary representation of the subclass (deserailized from the JSON)
2832
61
        :param kwargs: Contains any extra parameters. Not used!
2833
62
        :return: The desrialized object
2834
63
        """
2835
64
        return cls(**{key: obj[key] for key in cls._json_keys if obj.get(key) is not None})
2836
65
2837
66
    @classmethod
2838
67
    def attach_meta(cls, j_dict):
2839
68
        """
2840
69
        Attach meta data to the serialized dictionary.
2841
70
2842
71
        :param dict[str] j_dict: The dictionary to update with the meta data
2843
72
        :return None:
2844
73
        """
2845
74
        j_dict.update({'json_meta': {'class': cls._name or cls.__name__, 'version': cls._version}})
2846
75
2847
76
    def json_object(self, **kwargs):
2848
77
        """
2849
78
        Create a dictionary that can be JSON decoded.
2850
79
2851
80
        :param kwargs: Contains any extra parameters. Not used!
2852
81
        :return dict[str]: The dictionary representation of this Path object.
2853
82
        """
2854
83
        j_dict = {key: self.__dict__[key] for key in self._json_keys if self.__dict__.get(key) is not None}
2855
84
        self.attach_meta(j_dict)
2856
85
        return j_dict
2857
86
2858
87
2859
88
class OpenLPJSONDecoder(JSONDecoder):
2860
89
    """
2861
90
    Implement a custom JSONDecoder to extend compatibility to custom objects
2862
30
91
2863
31
    Example Usage:
92
    Example Usage:
2864
32
        object = json.loads(json_string, cls=OpenLPJsonDecoder)
93
        object = json.loads(json_string, cls=OpenLPJsonDecoder)
2865
@@ -45,23 +106,28 @@
2866
45
106
2867
46
    def custom_object_hook(self, obj):
107
    def custom_object_hook(self, obj):
2868
47
        """
108
        """
2870
48
        Implement a custom Path object decoder.
109
        Implement a custom object decoder.
2871
49
110
2872
50
        :param dict obj: A decoded JSON object
111
        :param dict obj: A decoded JSON object
2875
51
        :return: The original object literal, or a Path object if the object literal contains a key '__Path__'
112
        :return: The custom object from the serialized data if the custom object is registered, else obj
2874
52
        :rtype: dict | openlp.core.common.path.Path
2876
53
        """
113
        """
2877
54
        if '__Path__' in obj:
114
        if '__Path__' in obj:
2879
55
            obj = Path.encode_json(obj, **self.kwargs)
115
            return PathSerializer.encode_json(obj, **self.kwargs)
2880
116
        try:
2881
117
            key = obj['json_meta']['class']
2882
118
        except KeyError:
2883
119
            return obj
2884
120
        if key in _registered_classes:
2885
121
            return _registered_classes[key].encode_json(obj, **self.kwargs)
2886
56
        return obj
122
        return obj
2887
57
123
2888
58
124
2890
59
class OpenLPJsonEncoder(JSONEncoder):
125
class OpenLPJSONEncoder(JSONEncoder):
2891
60
    """
126
    """
2893
61
    Implement a custom JSONEncoder to handle Path objects
127
    Implement a custom JSONEncoder to handle to extend compatibility to custom objects
2894
62
128
2895
63
    Example Usage:
129
    Example Usage:
2897
64
        json_string = json.dumps(object, cls=OpenLPJsonEncoder)
130
        json_string = json.dumps(object, cls=OpenLPJSONEncoder)
2898
65
    """
131
    """
2899
66
    def __init__(self, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False,
132
    def __init__(self, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False,
2900
67
                 indent=None, separators=None, default=None, **kwargs):
133
                 indent=None, separators=None, default=None, **kwargs):
2901
@@ -78,12 +144,64 @@
2902
78
144
2903
79
    def custom_default(self, obj):
145
    def custom_default(self, obj):
2904
80
        """
146
        """
2906
81
        Convert any Path objects into a dictionary object which can be serialized.
147
        Convert any registered objects into a dictionary object which can be serialized.
2907
82
148
2908
83
        :param object obj: The object to convert
149
        :param object obj: The object to convert
2915
84
        :return: The serializable object
150
        :return dict: The serializable object
2916
85
        :rtype: dict
151
        """
2917
86
        """
152
        if isinstance(obj, JSONMixin):
2918
87
        if isinstance(obj, Path):
153
            return obj.json_object()
2919
88
            return obj.json_object(**self.kwargs)
154
        elif obj.__class__.__name__ in _registered_classes:
2920
89
        return super().default(obj)
155
            return _registered_classes[obj.__class__.__name__].json_object(obj, **self.kwargs)
2921
156
        return super().default(obj, **self.kwargs)
2922
157
2923
158
2924
159
def is_serializable(obj):
2925
160
    return obj.__class__.__name__ in _registered_classes
2926
161
2927
162
2928
163
class PathSerializer(JSONMixin, register_names=('Path', 'PosixPath', 'WindowsPath')):
2929
164
    """
2930
165
    Implement a de/serializer for pathlib.Path objects
2931
166
    """
2932
167
    _name = 'Path'
2933
168
2934
169
    @staticmethod
2935
170
    def encode_json(obj, base_path=None, **kwargs):
2936
171
        """
2937
172
        Reimplement encode_json to create a Path object from a dictionary representation.
2938
173
2939
174
        :param dict[str] obj: The dictionary representation
2940
175
        :param Path base_path: If specified, an absolute path to base the relative path off of.
2941
176
        :param kwargs: Contains any extra parameters. Not used!
2942
177
        :return Path: The deserialized Path object
2943
178
        """
2944
179
        if '__Path__' in obj:
2945
180
            parts = obj['__Path__']
2946
181
        else:
2947
182
            parts = obj['parts']
2948
183
        path = Path(*parts)
2949
184
        if base_path and not path.is_absolute():
2950
185
            return base_path / path
2951
186
        return path
2952
187
2953
188
    @classmethod
2954
189
    def json_object(cls, obj, base_path=None, is_js=False, **kwargs):
2955
190
        """
2956
191
        Create a dictionary that can be JSON decoded.
2957
192
2958
193
        :param Path base_path: If specified, an absolute path to make a relative path from.
2959
194
        :param bool is_js: Encode the path as a uri. For example for use in the js rendering code.
2960
195
        :param kwargs: Contains any extra parameters. Not used!
2961
196
        :return: The dictionary representation of this Path object.
2962
197
        :rtype: dict[tuple]
2963
198
        """
2964
199
        path = obj
2965
200
        if base_path:
2966
201
            with suppress(ValueError):
2967
202
                path = path.relative_to(base_path)
2968
203
        if is_js is True:
2969
204
            return path.as_uri()
2970
205
        json_dict = {'parts': path.parts}
2971
206
        cls.attach_meta(json_dict)
2972
207
        return json_dict
2973
90
208
2974
=== modified file 'openlp/core/common/mixins.py'
2975
--- openlp/core/common/mixins.py	2019-02-14 15:09:09 +0000
2976
+++ openlp/core/common/mixins.py	2019-07-01 17:47:01 +0000
2977
@@ -1,24 +1,24 @@
2978
1
# -*- coding: utf-8 -*-
1
# -*- coding: utf-8 -*-
2979
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
2980
3
3
2999
4
###############################################################################
4
##########################################################################
3000
5
# OpenLP - Open Source Lyrics Projection                                      #
5
# OpenLP - Open Source Lyrics Projection                                 #
3001
6
# --------------------------------------------------------------------------- #
6
# ---------------------------------------------------------------------- #
3002
7
# Copyright (c) 2008-2019 OpenLP Developers                                   #
7
# Copyright (c) 2008-2019 OpenLP Developers                              #
3003
8
# --------------------------------------------------------------------------- #
8
# ---------------------------------------------------------------------- #
3004
9
# This program is free software; you can redistribute it and/or modify it     #
9
# This program is free software: you can redistribute it and/or modify   #
3005
10
# under the terms of the GNU General Public License as published by the Free  #
10
# it under the terms of the GNU General Public License as published by   #
3006
11
# Software Foundation; version 2 of the License.                              #
11
# the Free Software Foundation, either version 3 of the License, or      #
3007
12
#                                                                             #
12
# (at your option) any later version.                                    #
3008
13
# This program is distributed in the hope that it will be useful, but WITHOUT #
13
#                                                                        #
3009
14
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
14
# This program is distributed in the hope that it will be useful,        #
3010
15
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
15
# but WITHOUT ANY WARRANTY; without even the implied warranty of         #
3011
16
# more details.                                                               #
16
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          #
3012
17
#                                                                             #
17
# GNU General Public License for more details.                           #
3013
18
# You should have received a copy of the GNU General Public License along     #
18
#                                                                        #
3014
19
# with this program; if not, write to the Free Software Foundation, Inc., 59  #
19
# You should have received a copy of the GNU General Public License      #
3015
20
# Temple Place, Suite 330, Boston, MA 02111-1307 USA                          #
20
# along with this program.  If not, see <https://www.gnu.org/licenses/>. #
3016
21
###############################################################################
21
##########################################################################
3017
22
"""
22
"""
3018
23
Provide Error Handling and login Services
23
Provide Error Handling and login Services
3019
24
"""
24
"""
3020
25
25
3021
=== modified file 'openlp/core/common/path.py'
3022
--- openlp/core/common/path.py	2019-02-14 15:09:09 +0000
3023
+++ openlp/core/common/path.py	2019-07-01 17:47:01 +0000
3024
@@ -1,86 +1,31 @@
3025
1
# -*- coding: utf-8 -*-
1
# -*- coding: utf-8 -*-
3026
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
3027
3
3
3046
4
###############################################################################
4
##########################################################################
3047
5
# OpenLP - Open Source Lyrics Projection                                      #
5
# OpenLP - Open Source Lyrics Projection                                 #
3048
6
# --------------------------------------------------------------------------- #
6
# ---------------------------------------------------------------------- #
3049
7
# Copyright (c) 2008-2019 OpenLP Developers                                   #
7
# Copyright (c) 2008-2019 OpenLP Developers                              #
3050
8
# --------------------------------------------------------------------------- #
8
# ---------------------------------------------------------------------- #
3051
9
# This program is free software; you can redistribute it and/or modify it     #
9
# This program is free software: you can redistribute it and/or modify   #
3052
10
# under the terms of the GNU General Public License as published by the Free  #
10
# it under the terms of the GNU General Public License as published by   #
3053
11
# Software Foundation; version 2 of the License.                              #
11
# the Free Software Foundation, either version 3 of the License, or      #
3054
12
#                                                                             #
12
# (at your option) any later version.                                    #
3055
13
# This program is distributed in the hope that it will be useful, but WITHOUT #
13
#                                                                        #
3056
14
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
14
# This program is distributed in the hope that it will be useful,        #
3057
15
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
15
# but WITHOUT ANY WARRANTY; without even the implied warranty of         #
3058
16
# more details.                                                               #
16
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          #
3059
17
#                                                                             #
17
# GNU General Public License for more details.                           #
3060
18
# You should have received a copy of the GNU General Public License along     #
18
#                                                                        #
3061
19
# with this program; if not, write to the Free Software Foundation, Inc., 59  #
19
# You should have received a copy of the GNU General Public License      #
3062
20
# Temple Place, Suite 330, Boston, MA 02111-1307 USA                          #
20
# along with this program.  If not, see <https://www.gnu.org/licenses/>. #
3063
21
###############################################################################
21
##########################################################################
3064
22
import logging
22
import logging
3065
23
import shutil
23
import shutil
3075
24
from contextlib import suppress
24
from pathlib import Path
3067
25
3068
26
from openlp.core.common import is_win
3069
27
3070
28
3071
29
if is_win():
3072
30
    from pathlib import WindowsPath as PathVariant          # pragma: nocover
3073
31
else:
3074
32
    from pathlib import PosixPath as PathVariant            # pragma: nocover
3076
33
25
3077
34
log = logging.getLogger(__name__)
26
log = logging.getLogger(__name__)
3078
35
27
3079
36
28
3080
37
class Path(PathVariant):
3081
38
    """
3082
39
    Subclass pathlib.Path, so we can add json conversion methods
3083
40
    """
3084
41
    @staticmethod
3085
42
    def encode_json(obj, base_path=None, **kwargs):
3086
43
        """
3087
44
        Create a Path object from a dictionary representation. The dictionary has been constructed by JSON encoding of
3088
45
        a JSON reprensation of a Path object.
3089
46
3090
47
        :param dict[str] obj: The dictionary representation
3091
48
        :param openlp.core.common.path.Path base_path: If specified, an absolute path to base the relative path off of.
3092
49
        :param kwargs: Contains any extra parameters. Not used!
3093
50
        :return: The reconstructed Path object
3094
51
        :rtype: openlp.core.common.path.Path
3095
52
        """
3096
53
        path = Path(*obj['__Path__'])
3097
54
        if base_path and not path.is_absolute():
3098
55
            return base_path / path
3099
56
        return path
3100
57
3101
58
    def json_object(self, base_path=None, **kwargs):
3102
59
        """
3103
60
        Create a dictionary that can be JSON decoded.
3104
61
3105
62
        :param openlp.core.common.path.Path base_path: If specified, an absolute path to make a relative path from.
3106
63
        :param kwargs: Contains any extra parameters. Not used!
3107
64
        :return: The dictionary representation of this Path object.
3108
65
        :rtype: dict[tuple]
3109
66
        """
3110
67
        path = self
3111
68
        if base_path:
3112
69
            with suppress(ValueError):
3113
70
                path = path.relative_to(base_path)
3114
71
        return {'__Path__': path.parts}
3115
72
3116
73
    def rmtree(self, ignore_errors=False, onerror=None):
3117
74
        """
3118
75
        Provide an interface to :func:`shutil.rmtree`
3119
76
3120
77
        :param bool ignore_errors: Ignore errors
3121
78
        :param onerror: Handler function to handle any errors
3122
79
        :rtype: None
3123
80
        """
3124
81
        shutil.rmtree(str(self), ignore_errors, onerror)
3125
82
3126
83
3127
84
def replace_params(args, kwargs, params):
29
def replace_params(args, kwargs, params):
3128
85
    """
30
    """
3129
86
    Apply a transformation function to the specified args or kwargs
31
    Apply a transformation function to the specified args or kwargs
3130
@@ -110,65 +55,11 @@
3131
110
    return tuple(args), kwargs
55
    return tuple(args), kwargs
3132
111
56
3133
112
57
3134
113
def copy(*args, **kwargs):
3135
114
    """
3136
115
    Wraps :func:`shutil.copy` so that we can accept Path objects.
3137
116
3138
117
    :param src openlp.core.common.path.Path: Takes a Path object which is then converted to a str object
3139
118
    :param dst openlp.core.common.path.Path: Takes a Path object which is then converted to a str object
3140
119
    :return: Converts the str object received from :func:`shutil.copy` to a Path or NoneType object
3141
120
    :rtype: openlp.core.common.path.Path | None
3142
121
3143
122
    See the following link for more information on the other parameters:
3144
123
        https://docs.python.org/3/library/shutil.html#shutil.copy
3145
124
    """
3146
125
3147
126
    args, kwargs = replace_params(args, kwargs, ((0, 'src', path_to_str), (1, 'dst', path_to_str)))
3148
127
3149
128
    return str_to_path(shutil.copy(*args, **kwargs))
3150
129
3151
130
3152
131
def copyfile(*args, **kwargs):
3153
132
    """
3154
133
    Wraps :func:`shutil.copyfile` so that we can accept Path objects.
3155
134
3156
135
    :param openlp.core.common.path.Path src: Takes a Path object which is then converted to a str object
3157
136
    :param openlp.core.common.path.Path dst: Takes a Path object which is then converted to a str object
3158
137
    :return: Converts the str object received from :func:`shutil.copyfile` to a Path or NoneType object
3159
138
    :rtype: openlp.core.common.path.Path | None
3160
139
3161
140
    See the following link for more information on the other parameters:
3162
141
        https://docs.python.org/3/library/shutil.html#shutil.copyfile
3163
142
    """
3164
143
3165
144
    args, kwargs = replace_params(args, kwargs, ((0, 'src', path_to_str), (1, 'dst', path_to_str)))
3166
145
3167
146
    return str_to_path(shutil.copyfile(*args, **kwargs))
3168
147
3169
148
3170
149
def copytree(*args, **kwargs):
3171
150
    """
3172
151
    Wraps :func:shutil.copytree` so that we can accept Path objects.
3173
152
3174
153
    :param openlp.core.common.path.Path src : Takes a Path object which is then converted to a str object
3175
154
    :param openlp.core.common.path.Path dst: Takes a Path object which is then converted to a str object
3176
155
    :return: Converts the str object received from :func:`shutil.copytree` to a Path or NoneType object
3177
156
    :rtype: openlp.core.common.path.Path | None
3178
157
3179
158
    See the following link for more information on the other parameters:
3180
159
        https://docs.python.org/3/library/shutil.html#shutil.copytree
3181
160
    """
3182
161
3183
162
    args, kwargs = replace_params(args, kwargs, ((0, 'src', path_to_str), (1, 'dst', path_to_str)))
3184
163
3185
164
    return str_to_path(shutil.copytree(*args, **kwargs))
3186
165
3187
166
3188
167
def which(*args, **kwargs):
58
def which(*args, **kwargs):
3189
168
    """
59
    """
3190
169
    Wraps :func:shutil.which` so that it return a Path objects.
60
    Wraps :func:shutil.which` so that it return a Path objects.
3191
170
61
3193
171
    :rtype: openlp.core.common.Path
62
    :rtype: Path
3194
172
63
3195
173
    See the following link for more information on the other parameters:
64
    See the following link for more information on the other parameters:
3196
174
        https://docs.python.org/3/library/shutil.html#shutil.which
65
        https://docs.python.org/3/library/shutil.html#shutil.which
3197
@@ -183,10 +74,12 @@
3198
183
    """
74
    """
3199
184
    A utility function to convert a Path object or NoneType to a string equivalent.
75
    A utility function to convert a Path object or NoneType to a string equivalent.
3200
185
76
3202
186
    :param openlp.core.common.path.Path | None path: The value to convert to a string
77
    :param Path | None path: The value to convert to a string
3203
187
    :return: An empty string if :param:`path` is None, else a string representation of the :param:`path`
78
    :return: An empty string if :param:`path` is None, else a string representation of the :param:`path`
3204
188
    :rtype: str
79
    :rtype: str
3205
189
    """
80
    """
3206
81
    if isinstance(path, str):
3207
82
        return path
3208
190
    if not isinstance(path, Path) and path is not None:
83
    if not isinstance(path, Path) and path is not None:
3209
191
        raise TypeError('parameter \'path\' must be of type Path or NoneType')
84
        raise TypeError('parameter \'path\' must be of type Path or NoneType')
3210
192
    if path is None:
85
    if path is None:
3211
@@ -204,7 +97,7 @@
3212
204
97
3213
205
    :param str string: The string to convert
98
    :param str string: The string to convert
3214
206
    :return: None if :param:`string` is empty, or a Path object representation of :param:`string`
99
    :return: None if :param:`string` is empty, or a Path object representation of :param:`string`
3216
207
    :rtype: openlp.core.common.path.Path | None
100
    :rtype: Path | None
3217
208
    """
101
    """
3218
209
    if not isinstance(string, str):
102
    if not isinstance(string, str):
3219
210
        log.error('parameter \'string\' must be of type str, got {} which is a {} instead'.format(string, type(string)))
103
        log.error('parameter \'string\' must be of type str, got {} which is a {} instead'.format(string, type(string)))
3220
@@ -218,7 +111,7 @@
3221
218
    """
111
    """
3222
219
    Create one or more paths
112
    Create one or more paths
3223
220
113
3225
221
    :param openlp.core.common.path.Path paths: The paths to create
114
    :param Path paths: The paths to create
3226
222
    :param bool do_not_log: To not log anything. This is need for the start up, when the log isn't ready.
115
    :param bool do_not_log: To not log anything. This is need for the start up, when the log isn't ready.
3227
223
    :rtype: None
116
    :rtype: None
3228
224
    """
117
    """
3229
@@ -239,7 +132,7 @@
3230
239
132
3231
240
    :param list[str] file_names: The list of file names to convert.
133
    :param list[str] file_names: The list of file names to convert.
3232
241
    :return: The list converted to file paths
134
    :return: The list converted to file paths
3234
242
    :rtype: openlp.core.common.path.Path
135
    :rtype: Path
3235
243
    """
136
    """
3236
244
    if file_names:
137
    if file_names:
3237
245
        return [str_to_path(file_name) for file_name in file_names]
138
        return [str_to_path(file_name) for file_name in file_names]
3238
246
139
3239
=== modified file 'openlp/core/common/registry.py'
3240
--- openlp/core/common/registry.py	2019-02-14 15:09:09 +0000
3241
+++ openlp/core/common/registry.py	2019-07-01 17:47:01 +0000
3242
@@ -1,24 +1,24 @@
3243
1
# -*- coding: utf-8 -*-
1
# -*- coding: utf-8 -*-
3244
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
3245
3
3
3264
4
###############################################################################
4
##########################################################################
3265
5
# OpenLP - Open Source Lyrics Projection                                      #
5
# OpenLP - Open Source Lyrics Projection                                 #
3266
6
# --------------------------------------------------------------------------- #
6
# ---------------------------------------------------------------------- #
3267
7
# Copyright (c) 2008-2019 OpenLP Developers                                   #
7
# Copyright (c) 2008-2019 OpenLP Developers                              #
3268
8
# --------------------------------------------------------------------------- #
8
# ---------------------------------------------------------------------- #
3269
9
# This program is free software; you can redistribute it and/or modify it     #
9
# This program is free software: you can redistribute it and/or modify   #
3270
10
# under the terms of the GNU General Public License as published by the Free  #
10
# it under the terms of the GNU General Public License as published by   #
3271
11
# Software Foundation; version 2 of the License.                              #
11
# the Free Software Foundation, either version 3 of the License, or      #
3272
12
#                                                                             #
12
# (at your option) any later version.                                    #
3273
13
# This program is distributed in the hope that it will be useful, but WITHOUT #
13
#                                                                        #
3274
14
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
14
# This program is distributed in the hope that it will be useful,        #
3275
15
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
15
# but WITHOUT ANY WARRANTY; without even the implied warranty of         #
3276
16
# more details.                                                               #
16
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          #
3277
17
#                                                                             #
17
# GNU General Public License for more details.                           #
3278
18
# You should have received a copy of the GNU General Public License along     #
18
#                                                                        #
3279
19
# with this program; if not, write to the Free Software Foundation, Inc., 59  #
19
# You should have received a copy of the GNU General Public License      #
3280
20
# Temple Place, Suite 330, Boston, MA 02111-1307 USA                          #
20
# along with this program.  If not, see <https://www.gnu.org/licenses/>. #
3281
21
###############################################################################
21
##########################################################################
3282
22
"""
22
"""
3283
23
Provide Registry Services
23
Provide Registry Services
3284
24
"""
24
"""
3285
@@ -146,7 +146,7 @@
3286
146
                try:
146
                try:
3287
147
                    log.debug('Running function {} for {}'.format(function, event))
147
                    log.debug('Running function {} for {}'.format(function, event))
3288
148
                    result = function(*args, **kwargs)
148
                    result = function(*args, **kwargs)
3290
149
                    if result:
149
                    if result is not None:
3291
150
                        results.append(result)
150
                        results.append(result)
3292
151
                except TypeError:
151
                except TypeError:
3293
152
                    # Who has called me can help in debugging
152
                    # Who has called me can help in debugging
3294
153
153
3295
=== modified file 'openlp/core/common/settings.py'
3296
--- openlp/core/common/settings.py	2019-02-14 15:09:09 +0000
3297
+++ openlp/core/common/settings.py	2019-07-01 17:47:01 +0000
3298
@@ -1,24 +1,24 @@
3299
1
# -*- coding: utf-8 -*-
1
# -*- coding: utf-8 -*-
3300
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
3301
3
3
3320
4
###############################################################################
4
##########################################################################
3321
5
# OpenLP - Open Source Lyrics Projection                                      #
5
# OpenLP - Open Source Lyrics Projection                                 #
3322
6
# --------------------------------------------------------------------------- #
6
# ---------------------------------------------------------------------- #
3323
7
# Copyright (c) 2008-2019 OpenLP Developers                                   #
7
# Copyright (c) 2008-2019 OpenLP Developers                              #
3324
8
# --------------------------------------------------------------------------- #
8
# ---------------------------------------------------------------------- #
3325
9
# This program is free software; you can redistribute it and/or modify it     #
9
# This program is free software: you can redistribute it and/or modify   #
3326
10
# under the terms of the GNU General Public License as published by the Free  #
10
# it under the terms of the GNU General Public License as published by   #
3327
11
# Software Foundation; version 2 of the License.                              #
11
# the Free Software Foundation, either version 3 of the License, or      #
3328
12
#                                                                             #
12
# (at your option) any later version.                                    #
3329
13
# This program is distributed in the hope that it will be useful, but WITHOUT #
13
#                                                                        #
3330
14
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
14
# This program is distributed in the hope that it will be useful,        #
3331
15
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
15
# but WITHOUT ANY WARRANTY; without even the implied warranty of         #
3332
16
# more details.                                                               #
16
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          #
3333
17
#                                                                             #
17
# GNU General Public License for more details.                           #
3334
18
# You should have received a copy of the GNU General Public License along     #
18
#                                                                        #
3335
19
# with this program; if not, write to the Free Software Foundation, Inc., 59  #
19
# You should have received a copy of the GNU General Public License      #
3336
20
# Temple Place, Suite 330, Boston, MA 02111-1307 USA                          #
20
# along with this program.  If not, see <https://www.gnu.org/licenses/>. #
3337
21
###############################################################################
21
##########################################################################
3338
22
"""
22
"""
3339
23
This class contains the core default settings.
23
This class contains the core default settings.
3340
24
"""
24
"""
3341
@@ -27,13 +27,14 @@
3342
27
import logging
27
import logging
3343
28
import os
28
import os
3344
29
from enum import IntEnum
29
from enum import IntEnum
3345
30
from pathlib import Path
3346
30
from tempfile import gettempdir
31
from tempfile import gettempdir
3347
31
32
3348
32
from PyQt5 import QtCore, QtGui
33
from PyQt5 import QtCore, QtGui
3349
33
34
3350
34
from openlp.core.common import SlideLimits, ThemeLevel, is_linux, is_win
35
from openlp.core.common import SlideLimits, ThemeLevel, is_linux, is_win
3353
35
from openlp.core.common.json import OpenLPJsonDecoder, OpenLPJsonEncoder
36
from openlp.core.common.json import OpenLPJSONDecoder, OpenLPJSONEncoder, is_serializable
3354
36
from openlp.core.common.path import Path, files_to_paths, str_to_path
37
from openlp.core.common.path import files_to_paths, str_to_path
3355
37
38
3356
38
39
3357
39
log = logging.getLogger(__name__)
40
log = logging.getLogger(__name__)
3358
@@ -177,14 +178,13 @@
3359
177
        'api/thumbnails': True,
178
        'api/thumbnails': True,
3360
178
        'crashreport/last directory': None,
179
        'crashreport/last directory': None,
3361
179
        'formattingTags/html_tags': '',
180
        'formattingTags/html_tags': '',
3362
180
        'core/audio repeat list': False,
3363
181
        'core/auto open': False,
181
        'core/auto open': False,
3364
182
        'core/auto preview': False,
182
        'core/auto preview': False,
3365
183
        'core/audio start paused': True,
3366
184
        'core/auto unblank': False,
183
        'core/auto unblank': False,
3367
185
        'core/click live slide to unblank': False,
184
        'core/click live slide to unblank': False,
3368
186
        'core/blank warning': False,
185
        'core/blank warning': False,
3369
187
        'core/ccli number': '',
186
        'core/ccli number': '',
3370
187
        'advanced/experimental': False,
3371
188
        'core/has run wizard': False,
188
        'core/has run wizard': False,
3372
189
        'core/language': '[en]',
189
        'core/language': '[en]',
3373
190
        'core/last version test': '',
190
        'core/last version test': '',
3374
@@ -202,13 +202,16 @@
3375
202
        'core/view mode': 'default',
202
        'core/view mode': 'default',
3376
203
        # The other display settings (display position and dimensions) are defined in the ScreenList class due to a
203
        # The other display settings (display position and dimensions) are defined in the ScreenList class due to a
3377
204
        # circular dependency.
204
        # circular dependency.
3379
205
        'core/display on monitor': True,
205
        'core/display on monitor': False,
3380
206
        'core/override position': False,
206
        'core/override position': False,
3381
207
        'core/monitor': {},
207
        'core/monitor': {},
3382
208
        'core/application version': '0.0',
208
        'core/application version': '0.0',
3383
209
        'images/background color': '#000000',
209
        'images/background color': '#000000',
3386
210
        'media/players': 'system,webkit',
210
        'media/media auto start': QtCore.Qt.Unchecked,
3387
211
        'media/override player': QtCore.Qt.Unchecked,
211
        'media/stream command': '',
3388
212
        'media/vlc arguments': '',
3389
213
        'media/video': '',
3390
214
        'media/audio': '',
3391
212
        'remotes/download version': '0.0',
215
        'remotes/download version': '0.0',
3392
213
        'players/background color': '#000000',
216
        'players/background color': '#000000',
3393
214
        'servicemanager/last directory': None,
217
        'servicemanager/last directory': None,
3394
@@ -311,7 +314,11 @@
3395
311
        ('bibles/proxy name', '', []),  # Just remove these bible proxy settings. They weren't used in 2.4!
314
        ('bibles/proxy name', '', []),  # Just remove these bible proxy settings. They weren't used in 2.4!
3396
312
        ('bibles/proxy address', '', []),
315
        ('bibles/proxy address', '', []),
3397
313
        ('bibles/proxy username', '', []),
316
        ('bibles/proxy username', '', []),
3399
314
        ('bibles/proxy password', '', [])
317
        ('bibles/proxy password', '', []),
3400
318
        ('media/players', '', []),
3401
319
        ('media/override player', '', []),
3402
320
        ('core/audio start paused', '', []),
3403
321
        ('core/audio repeat list', '', [])
3404
315
    ]
322
    ]
3405
316
323
3406
317
    @staticmethod
324
    @staticmethod
3407
@@ -330,7 +337,7 @@
3408
330
337
3409
331
        Does not affect existing Settings objects.
338
        Does not affect existing Settings objects.
3410
332
339
3412
333
        :param openlp.core.common.path.Path ini_path: ini file path
340
        :param Path ini_path: ini file path
3413
334
        :rtype: None
341
        :rtype: None
3414
335
        """
342
        """
3415
336
        Settings.__file_path__ = str(ini_path)
343
        Settings.__file_path__ = str(ini_path)
3416
@@ -540,7 +547,7 @@
3417
540
                        old_values = [self._convert_value(old_value, default_value)
547
                        old_values = [self._convert_value(old_value, default_value)
3418
541
                                      for old_value, default_value in zip(old_values, default_values)]
548
                                      for old_value, default_value in zip(old_values, default_values)]
3419
542
                    # Iterate over our rules and check what the old_value should be "converted" to.
549
                    # Iterate over our rules and check what the old_value should be "converted" to.
3421
543
                    new_value = None
550
                    new_value = old_values[0]
3422
544
                    for new_rule, old_rule in rules:
551
                    for new_rule, old_rule in rules:
3423
545
                        # If the value matches with the condition (rule), then use the provided value. This is used to
552
                        # If the value matches with the condition (rule), then use the provided value. This is used to
3424
546
                        # convert values. E. g. an old value 1 results in True, and 0 in False.
553
                        # convert values. E. g. an old value 1 results in True, and 0 in False.
3425
@@ -577,8 +584,9 @@
3426
577
        :param value: The value to save
584
        :param value: The value to save
3427
578
        :rtype: None
585
        :rtype: None
3428
579
        """
586
        """
3431
580
        if isinstance(value, (Path, dict)) or (isinstance(value, list) and value and isinstance(value[0], Path)):
587
        if is_serializable(value) or isinstance(value, dict) or \
3432
581
            value = json.dumps(value, cls=OpenLPJsonEncoder)
588
                (isinstance(value, list) and value and is_serializable(value[0])):
3433
589
            value = json.dumps(value, cls=OpenLPJSONEncoder)
3434
582
        super().setValue(key, value)
590
        super().setValue(key, value)
3435
583
591
3436
584
    def _convert_value(self, setting, default_value):
592
    def _convert_value(self, setting, default_value):
3437
@@ -604,8 +612,8 @@
3438
604
            elif isinstance(default_value, dict):
612
            elif isinstance(default_value, dict):
3439
605
                return {}
613
                return {}
3440
606
        elif isinstance(setting, str):
614
        elif isinstance(setting, str):
3443
607
            if '__Path__' in setting or setting.startswith('{'):
615
            if 'json_meta' in setting or '__Path__' in setting or setting.startswith('{'):
3444
608
                return json.loads(setting, cls=OpenLPJsonDecoder)
616
                return json.loads(setting, cls=OpenLPJSONDecoder)
3445
609
        # Convert the setting to the correct type.
617
        # Convert the setting to the correct type.
3446
610
        if isinstance(default_value, bool):
618
        if isinstance(default_value, bool):
3447
611
            if isinstance(setting, bool):
619
            if isinstance(setting, bool):
3448
@@ -622,7 +630,7 @@
3449
622
        """
630
        """
3450
623
        Export the settings to file.
631
        Export the settings to file.
3451
624
632
3453
625
        :param openlp.core.common.path.Path dest_path: The file path to create the export file.
633
        :param Path dest_path: The file path to create the export file.
3454
626
        :return: Success
634
        :return: Success
3455
627
        :rtype: bool
635
        :rtype: bool
3456
628
        """
636
        """
3457
629
637
3458
=== modified file 'openlp/core/display/__init__.py'
3459
--- openlp/core/display/__init__.py	2019-02-14 15:09:09 +0000
3460
+++ openlp/core/display/__init__.py	2019-07-01 17:47:01 +0000
3461
@@ -1,24 +1,24 @@
3462
1
# -*- coding: utf-8 -*-
1
# -*- coding: utf-8 -*-
3463
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
2
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
3464
3
3
3483
4
###############################################################################
4
##########################################################################
3484
5
# OpenLP - Open Source Lyrics Projection                                      #
5
# OpenLP - Open Source Lyrics Projection                                 #
3485
6
# --------------------------------------------------------------------------- #
6
# ---------------------------------------------------------------------- #
3486
7
# Copyright (c) 2008-2019 OpenLP Developers                                   #
7
# Copyright (c) 2008-2019 OpenLP Developers                              #
3487
8
# --------------------------------------------------------------------------- #
8
# ---------------------------------------------------------------------- #
3488
9
# This program is free software; you can redistribute it and/or modify it     #
9
# This program is free software: you can redistribute it and/or modify   #
3489
10
# under the terms of the GNU General Public License as published by the Free  #
10
# it under the terms of the GNU General Public License as published by   #
3490
11
# Software Foundation; version 2 of the License.                              #
11
# the Free Software Foundation, either version 3 of the License, or      #
3491
12
#                                                                             #
12
# (at your option) any later version.                                    #
3492
13
# This program is distributed in the hope that it will be useful, but WITHOUT #
13
#                                                                        #
3493
14
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
14
# This program is distributed in the hope that it will be useful,        #
3494
15
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
15
# but WITHOUT ANY WARRANTY; without even the implied warranty of         #
3495
16
# more details.                                                               #
16
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          #
3496
17
#                                                                             #
17
# GNU General Public License for more details.                           #
3497
18
# You should have received a copy of the GNU General Public License along     #
18
#                                                                        #
3498
19
# with this program; if not, write to the Free Software Foundation, Inc., 59  #
19
# You should have received a copy of the GNU General Public License      #
3499
20
# Temple Place, Suite 330, Boston, MA 02111-1307 USA                          #
20
# along with this program.  If not, see <https://www.gnu.org/licenses/>. #
3500
21
###############################################################################
21
##########################################################################
3501
22
"""
22
"""
3502
23
The :mod:`~openlp.core.display` module contains all the code related to rendering and output
23
The :mod:`~openlp.core.display` module contains all the code related to rendering and output
3503
24
"""
24
"""
3504
25
25
3505
=== added file 'openlp/core/display/html/display.css'
3506
--- openlp/core/display/html/display.css	1970-01-01 00:00:00 +0000
3507
+++ openlp/core/display/html/display.css	2019-07-01 17:47:01 +0000
3508
@@ -0,0 +1,80 @@
3509
1
@keyframes alert-scrolling-text {
3510
2
  0% { transform: translateX(100%); opacity: 1; }
3511
3
  99% { opacity: 1; }
3512
4
  100% { transform: translateX(-101%); opacity: 0;}
3513
5
}
3514
6
3515
7
/* ALERT BACKGROUND STYLING */
3516
8
.bg-default {
3517
9
  position: absolute;
3518
10
  margin: 0;
3519
11
  padding: 0;
3520
12
  left: 0;
3521
13
  z-index: 11;
3522
14
  width: 100%;
3523
15
  height: 0;
3524
16
  min-height: 0;
3525
17
  overflow: hidden;
3526
18
  transform: translate(0,0);
3527
19
  transition: min-height 1s ease-out .5s;
3528
20
  white-space: nowrap;
3529
21
  display: flex;
3530
22
  flex-direction: row;  
3531
23
  align-items: center;
3532
24
  /* align-content: center; */
3533
25
}
3534
26
3535
27
.bg-default span {
3536
28
  display: inline-block;
3537
29
  padding-left: 120%;
3538
30
}
3539
31
3540
32
.show-bg {
3541
33
  /* height: auto; */
3542
34
  min-height: 25%;
3543
35
  transition: min-height 1s ease-in .5s;
3544
36
}
3545
37
3546
38
.middle {  
3547
39
  align-items: center;
3548
40
}
3549
41
3550
42
.alert-container {
3551
43
  position: absolute;
3552
44
  display: flex;
3553
45
  flex-direction: row;
3554
46
  height: 100vh;
3555
47
  width: 100vw;    
3556
48
}
3557
49
3558
50
.top { 
3559
51
  align-items: flex-start;
3560
52
}
3561
53
3562
54
.bottom {  
3563
55
  align-items: flex-end;
3564
56
}
3565
57
3566
58
/* ALERT TEXT STYLING */
3567
59
#alert {  
3568
60
  z-index: 100;  
3569
61
  overflow: visible;  
3570
62
  color: #ffffff;
3571
63
  font-size: 40pt;    
3572
64
  padding: 0;
3573
65
  margin: 0;
3574
66
  opacity: 0; 
3575
67
  transition: opacity .5s linear;   
3576
68
}
3577
69
3578
70
#alert.hide-text {
3579
71
  opacity: 0;
3580
72
}
3581
73
3582
74
#alert.show-text {  
3583
75
  transform: none;
3584
76
  transition: none;
3585
77
  animation: none;
3586
78
  padding: auto 5px;
3587
79
  opacity: 1;   
3588
80
}
3589
0
81
3590
=== modified file 'openlp/core/display/html/display.html'
3591
--- openlp/core/display/html/display.html	2018-10-12 19:51:51 +0000
3592
+++ openlp/core/display/html/display.html	2019-07-01 17:47:01 +0000
3593
@@ -2,11 +2,11 @@
3594
2
<html>
2
<html>
3595
3
  <head>
3
  <head>
3596
4
    <title>Display Window</title>
4
    <title>Display Window</title>
3598
5
    <link href="reveal.css" rel="stylesheet">
5
    <link href="reveal.css" rel="stylesheet">  
3599
6
    <style type="text/css">
6
    <style type="text/css">
3600
7
    body {
7
    body {
3601
8
      background: transparent !important;
8
      background: transparent !important;
3603
9
      color: #fff !important;
9
      color: rgb(255, 255, 255) !important;
3604
10
    }
10
    }
3605
11
    sup {
11
    sup {
3606
12
      vertical-align: super !important;
12
      vertical-align: super !important;
3607
@@ -24,16 +24,21 @@
3608
24
      visibility: visible;
24
      visibility: visible;
3609
25
      z-index: -1;
25
      z-index: -1;
3610
26
    }
26
    }
3612
27
    </style>
27
    </style>    
3613
28
    <link rel="stylesheet" type="text/css" href="display.css"></link>
3614
28
    <script type="text/javascript" src="qrc:///qtwebchannel/qwebchannel.js"></script>
29
    <script type="text/javascript" src="qrc:///qtwebchannel/qwebchannel.js"></script>
3615
29
    <script type="text/javascript" src="reveal.js"></script>
30
    <script type="text/javascript" src="reveal.js"></script>
3616
30
    <script type="text/javascript" src="display.js"></script>
31
    <script type="text/javascript" src="display.js"></script>
3617
31
  </head>
32
  </head>
3618
33
3619
32
  <body>
34
  <body>
3620
35
    <div class="alert-container">
3621
36
      <div id="alert-background" class="bg-default"><span id="alert">Testing alerts</span></div>
3622
37
    </div>
3623
33
    <div class="reveal">
38
    <div class="reveal">
3625
34
      <div id="global-background" class="slide-background present" data-loaded="true"></div>
39
      <div id="global-background" class="slide-background present" data-loaded="true"></div>      
3626
35
      <div class="slides"></div>
40
      <div class="slides"></div>
3627
36
      <div class="footer"></div>
41
      <div class="footer"></div>
3629
37
    </div>
42
    </div>    
3630
38
  </body>
43
  </body>
3631
39
</html>
44
</html>
3632
40
45
3633
=== modified file 'openlp/core/display/html/display.js'
3634
--- openlp/core/display/html/display.js	2019-02-05 21:26:30 +0000
3635
+++ openlp/core/display/html/display.js	2019-07-01 17:47:01 +0000
3636
@@ -53,6 +53,50 @@
3637
53
};
53
};
3638
54
54
3639
55
/**
55
/**
3640
56
 * Transition state enumeration
3641
57
 */
3642
58
var TransitionState = {
3643
59
  EntranceTransition: "entranceTransition",
3644
60
  NoTransition: "noTransition",
3645
61
  ExitTransition: "exitTransition"
3646
62
};
3647
63
3648
64
/**
3649
65
 * Animation state enumeration
3650
66
 */
3651
67
var AnimationState = {
3652
68
  NoAnimation: "noAnimation",
3653
69
  ScrollingText: "scrollingText",
3654
70
  NonScrollingText: "noScrollingText"
3655
71
};
3656
72
3657
73
/**
3658
74
 * Alert location enumeration
3659
75
 */
3660
76
var AlertLocation = {
3661
77
  Top: 0,
3662
78
  Middle: 1,
3663
79
  Bottom: 2
3664
80
};
3665
81
3666
82
/**
3667
83
 * Alert state enumeration
3668
84
 */
3669
85
var AlertState = {
3670
86
  Displaying: "displaying",  
3671
87
  NotDisplaying: "notDisplaying"
3672
88
}
3673
89
3674
90
/**
3675
91
 * Alert delay enumeration 
3676
92
 */
3677
93
var AlertDelay = {
3678
94
  FiftyMilliseconds: 50,
3679
95
  OneSecond: 1000,
3680
96
  OnePointFiveSeconds: 1500
3681
97
}
3682
98
3683
99
/**
3684
56
 * Return an array of elements based on the selector query
100
 * Return an array of elements based on the selector query
3685
57
 * @param {string} selector - The selector to find elements
101
 * @param {string} selector - The selector to find elements
3686
58
 * @returns {array} An array of matching elements
102
 * @returns {array} An array of matching elements
3687
@@ -118,20 +162,6 @@
3688
118
}
162
}
3689
119
163
3690
120
/**
164
/**
3691
121
 * The paths we get are JSON versions of Python Path objects, so let's just fix that.
3692
122
 * @private
3693
123
 * @param {object} path - The Path object
3694
124
 * @returns {string} The actual file path
3695
125
 */
3696
126
function _pathToString(path) {
3697
127
    var filename = path.__Path__.join("/").replace("//", "/");
3698
128
    if (!filename.startsWith("/")) {
3699
129
        filename = "/" + filename;
3700
130
    }
3701
131
    return filename;
3702
132
}
3703
133
3704
134
/**
3705
135
 * An audio player with a play list
165
 * An audio player with a play list
3706
136
 */
166
 */
3707
137
var AudioPlayer = function (audioElement) {
167
var AudioPlayer = function (audioElement) {
3708
@@ -248,7 +278,12 @@
3709
248
 * The Display object is what we use from OpenLP
278
 * The Display object is what we use from OpenLP
3710
249
 */
279
 */
3711
250
var Display = {
280
var Display = {
3712
281
  _alerts: [],
3713
251
  _slides: {},
282
  _slides: {},
3714
283
  _alertSettings: {},
3715
284
  _alertState: AlertState.NotDisplaying,
3716
285
  _transitionState: TransitionState.NoTransition,
3717
286
  _animationState: AnimationState.NoAnimation,
3718
252
  _revealConfig: {
287
  _revealConfig: {
3719
253
    margin: 0.0,
288
    margin: 0.0,
3720
254
    minScale: 1.0,
289
    minScale: 1.0,
3721
@@ -315,7 +350,7 @@
3722
315
    section.setAttribute("style", "height: 100%; width: 100%; position: relative;");
350
    section.setAttribute("style", "height: 100%; width: 100%; position: relative;");
3723
316
    var img = document.createElement('img');
351
    var img = document.createElement('img');
3724
317
    img.src = image;
352
    img.src = image;
3726
318
    img.setAttribute("style", "position: absolute; top: 0; bottom: 0; left: 0; right: 0; margin: auto;");
353
    img.setAttribute("style", "position: absolute; top: 0; bottom: 0; left: 0; right: 0; margin: auto; max-height: 100%; max-width: 100%");
3727
319
    section.appendChild(img);
354
    section.appendChild(img);
3728
320
    slidesDiv.appendChild(section);
355
    slidesDiv.appendChild(section);
3729
321
    Display._slides['0'] = 0;
356
    Display._slides['0'] = 0;
3730
@@ -370,19 +405,197 @@
3731
370
  /**
405
  /**
3732
371
   * Display an alert
406
   * Display an alert
3733
372
   * @param {string} text - The alert text
407
   * @param {string} text - The alert text
3747
373
   * @param {int} location - The location of the text (top, middle or bottom)
408
   * @param {string} JSON object - The settings for the alert object e.g '{"backgroundColor": "rgb(255, 85, 0)", 
3748
374
  */
409
   * "location": 1, "fontFace": "Open Sans Condensed", "fontSize": 90, "fontColor": "rgb(255, 255, 255)", 
3749
375
 alert: function (text, location) {
410
   * "timeout": 10, "repeat": 2, "scroll": true}'
3750
376
  console.debug(" alert text: " + text, ", location: " + location);
411
  */
3751
377
  /*
412
  alert: function (text, alertSettings) {
3752
378
   * The implementation should show an alert.
413
    var alertBackground = $('#alert-background')[0];
3753
379
   * It should be able to handle receiving a new alert before a previous one is "finished", basically queueing it.
414
    var alertText = $('#alert')[0];
3754
380
   */
415
    if (text == "") {
3755
381
  return;
416
      return null;
3756
382
},
417
    }
3757
383
418
    else {
3758
384
  /**
419
      if (this._alertState === AlertState.Displaying) {
3759
385
   * Add a slides. If the slide exists but the HTML is different, update the slide.
420
        Display.addAlertToQueue(text, alert_settings);
3760
421
      }
3761
422
    }
3762
423
    var settings = JSON.parse(alertSettings);
3763
424
    this._alertSettings = settings;    
3764
425
    Display.setAlertText(text, settings.fontColor, settings.fontFace, settings.fontSize);
3765
426
    Display.setAlertLocation(settings.location);    
3766
427
    /* Check if the alert is a queued alert */
3767
428
    if (Display._alertState !== AlertState.DisplayingFromQueue) {
3768
429
      Display._alertState = AlertState.Displaying;
3769
430
    }
3770
431
    
3771
432
    alertBackground.addEventListener('transitionend', Display.alertTransitionEndEvent, false);            
3772
433
    alertText.addEventListener('animationend', Display.alertAnimationEndEvent, false);                          
3773
434
    
3774
435
    Display.showAlertBackground(settings.backgroundColor);                
3775
436
  },  
3776
437
  /**
3777
438
   * Add an alert to the alert queue 
3778
439
   * @param {string} text - The alert text to be displayed
3779
440
   * @param {string} setttings - JSON object containing the settings for the alert
3780
441
   */
3781
442
  addAlertToQueue: function (text, settings) {
3782
443
    var alertObject = {text: text, settings: settings};        
3783
444
    this._alerts.push(JSON.stringify(alertObject));
3784
445
    return null;   
3785
446
  },
3786
447
  /**
3787
448
   * Set Alert Text
3788
449
   * @param {string} text - The alert text to display
3789
450
   */
3790
451
  setAlertText: function (text, color, fontFace, fontSize) {
3791
452
    var alertText = $("#alert")[0];
3792
453
    alertText.textContent = text;
3793
454
    alertText.style.color = color;
3794
455
    alertText.style.fontFamily = fontFace;
3795
456
    alertText.style.fontSize = fontSize + "pt";
3796
457
  },      
3797
458
  /**
3798
459
   * The alertTransitionEndEvent called after a transition has ended
3799
460
   */
3800
461
  alertTransitionEndEvent: function (e) {
3801
462
    e.stopPropagation();
3802
463
    console.debug("Transition end event reached");    
3803
464
    if (Display._transitionState === TransitionState.EntranceTransition) {        
3804
465
      Display._transitionState = TransitionState.NoTransition;
3805
466
      Display.showAlertText(Display._alertSettings);      
3806
467
    }
3807
468
    else if (Display._transitionState === TransitionState.ExitTransition) {        
3808
469
      Display._transitionState = TransitionState.NoTransition;      
3809
470
      Display.removeAlertLocation(Display._alertSettings.location);
3810
471
      Display.clearAlertSettings();      
3811
472
      setTimeout(function () {        
3812
473
        Display.showNextAlert();
3813
474
      }, AlertDelay.OnePointFiveSeconds);
3814
475
              
3815
476
    }    
3816
477
  },
3817
478
  /**
3818
479
   * The alertAnimationEndEvent called after an animation has ended
3819
480
   */
3820
481
  alertAnimationEndEvent: function (e) {
3821
482
    e.stopPropagation();                     
3822
483
    Display.hideAlertText(); 
3823
484
  },
3824
485
  /**
3825
486
   * Start background entrance transition for display of alert
3826
487
   * @param {string} hex_color - The background color of the alert
3827
488
   */
3828
489
  showAlertBackground: function (bg_color) {    
3829
490
    var alertBackground = $("#alert-background")[0];              
3830
491
    alertBackground.classList.add("show-bg");      
3831
492
    alertBackground.style.backgroundColor = bg_color;            
3832
493
    this._transitionState = TransitionState.EntranceTransition;
3833
494
  },
3834
495
  /**
3835
496
   * Set the location of the alert
3836
497
   * @param {int} location - Integer number with the location of the alert on screen
3837
498
   */
3838
499
  setAlertLocation: function (location) {
3839
500
    var alertContainer = $(".alert-container")[0];
3840
501
3841
502
    switch (location) {
3842
503
      case AlertLocation.Top:
3843
504
        alertContainer.classList.add("top");                       
3844
505
        break;
3845
506
      case AlertLocation.Middle:
3846
507
        alertContainer.classList.add("middle");                
3847
508
        break;
3848
509
      case AlertLocation.Bottom:
3849
510
      default:
3850
511
        alertContainer.classList.add("bottom");                       
3851
512
        break;
3852
513
    }    
3853
514
  },
3854
515
  /**
3855
516
   * Remove the location class set after displaying the alert
3856
517
   * @param {int} location - Integer number with the location of the alert on screen
3857
518
   */
3858
519
  removeAlertLocation: function (location) {
3859
520
    var alertContainer = $(".alert-container")[0];
3860
521
    console.debug("The value of location for removal is: " + location);
3861
522
3862
523
    switch (location) {
3863
524
      case AlertLocation.Top:
3864
525
        alertContainer.classList.remove("top");                       
3865
526
        break;
3866
527
      case AlertLocation.Middle:
3867
528
        alertContainer.classList.remove("middle");                
3868
529
        break;
3869
530
      case AlertLocation.Bottom:
3870
531
      default:
3871
532
        alertContainer.classList.remove("bottom");                       
3872
533
        break;
3873
534
    }    
3874
535
  },
3875
536
  /**
3876
537
   * Hide the alert background after the alert has been shown
3877
538
   */
3878
539
  hideAlertBackground: function () {
3879
540
    var alertBackground = $("#alert-background")[0];
3880
541
    alertBackground.classList.remove("show-bg");        
3881
542
    this._transitionState = TransitionState.ExitTransition;
3882
543
    this._alertState = AlertState.NotDisplaying;        
3883
544
  },  
3884
545
  /**
3885
546
   * Sets the alert text styles correctly after the entrance transition has ended.
3886
547
   * @param {json} settings object - The settings to use for the animation
3887
548
   */
3888
549
  showAlertText: function (settings) {        
3889
550
    var alertText = $("#alert")[0];        
3890
551
            
3891
552
    if (settings.scroll) {      
3892
553
      var animationSettings = "alert-scrolling-text " + settings.timeout +
3893
554
                              "s linear 0.6s " + settings.repeat + " normal";       
3894
555
      alertText.style.animation = animationSettings;
3895
556
      Display._animationState = AnimationState.ScrollingText;
3896
557
    }
3897
558
    else {                
3898
559
      Display._animationState = AnimationState.NonScrollingText;       
3899
560
      alertText.classList.add("show-text");      
3900
561
      setTimeout (function () {                       
3901
562
        Display._animationState = AnimationState.NoAnimation;
3902
563
        alertText.classList.add("hide-text");
3903
564
        alertText.classList.remove("show-text");    
3904
565
        Display.hideAlertText();
3905
566
      }, settings.timeout * AlertDelay.OneSecond);
3906
567
    }                 
3907
568
  },
3908
569
  /**
3909
570
   *  Reset styling and hide the alert text after displaying the animation
3910
571
   */
3911
572
  hideAlertText: function () {
3912
573
    var alertText = $('#alert')[0];            
3913
574
    Display._animationState = AnimationState.NoAnimation;
3914
575
    alertText.style.animation = "";    
3915
576
    Display.hideAlertBackground();                                            
3916
577
  },
3917
578
  /** 
3918
579
  * Display the next alert in the queue
3919
580
  */
3920
581
  showNextAlert: function () {      
3921
582
    if (Display._alerts.length > 0) {
3922
583
      var alertObject = JSON.parse(this._alerts.shift());
3923
584
      this._alertState = AlertState.DisplayingFromQueue;
3924
585
      Display.alert(alertObject.text, alertObject.settings);    
3925
586
    } 
3926
587
    else {
3927
588
      return null;
3928
589
    }
3929
590
  },
3930
591
  /**
3931
592
   * Clears the alert settings after displaying an alert 
3932
593
   */
3933
594
  clearAlertSettings: function () {    
3934
595
    this._alertSettings = {};    
3935
596
  },
3936
597
  /**
3937
598
   * Add a slide. If the slide exists but the HTML is different, update the slide.
3938
386
   * @param {string} verse - The verse number, e.g. "v1"
599
   * @param {string} verse - The verse number, e.g. "v1"
3939
387
   * @param {string} text - The HTML for the verse, e.g. "line1<br>line2"
600
   * @param {string} text - The HTML for the verse, e.g. "line1<br>line2"
3940
388
   * @param {string} footer_text - The HTML for the footer"
601
   * @param {string} footer_text - The HTML for the footer"
3941
@@ -676,13 +889,13 @@
3942
676
        }
889
        }
3943
677
        break;
890
        break;
3944
678
      case BackgroundType.Image:
891
      case BackgroundType.Image:
3947
679
        background_filename = _pathToString(theme.background_filename);
892
        backgroundStyle["background-image"] = "url('" + theme.background_filename + "')";
3948
680
        backgroundStyle["background-image"] = "url('file://" + background_filename + "')";
893
        console.warn(backgroundStyle["background-image"]);
3949
681
        break;
894
        break;
3950
682
      case BackgroundType.Video:
895
      case BackgroundType.Video:
3951
683
        background_filename = _pathToString(theme.background_filename);
3952
684
        backgroundStyle["background-color"] = theme.background_border_color;
896
        backgroundStyle["background-color"] = theme.background_border_color;
3954
685
        backgroundHtml = "<video loop autoplay muted><source src='file://" + background_filename + "'></video>";
897
        backgroundHtml = "<video loop autoplay muted><source src='" + theme.background_filename + "'></video>";
3955
898
        console.warn(backgroundHtml);
3956
686
        break;
899
        break;
3957
687
      default:
900
      default:
3958
688
        backgroundStyle["background"] = "#000";
901
        backgroundStyle["background"] = "#000";
3959
689
902
3960
=== modified file 'openlp/core/display/html/reveal.js'
3961
--- openlp/core/display/html/reveal.js	2019-02-11 20:34:20 +0000
3962
+++ openlp/core/display/html/reveal.js	2019-07-01 17:47:01 +0000
3963
@@ -3,7 +3,7 @@
3964
3
 * http://revealjs.com
3
 * http://revealjs.com
3965
4
 * MIT licensed
4
 * MIT licensed
3966
5
 *
5
 *
3968
6
 * Copyright (C) 2018 Hakim El Hattab, http://hakim.se
6
 * Copyright (C) 2019 Hakim El Hattab, http://hakim.se
3969
7
 */
7
 */
3970
8
(function( root, factory ) {
8
(function( root, factory ) {
3971
9
	if( typeof define === 'function' && define.amd ) {
9
	if( typeof define === 'function' && define.amd ) {
3972
@@ -26,7 +26,7 @@
3973
26
	var Reveal;
26
	var Reveal;
3974
27
27
3975
28
	// The reveal.js version
28
	// The reveal.js version
3977
29
	var VERSION = '3.7.0';
29
	var VERSION = '3.8.0';
3978
30
30
3979
31
	var SLIDES_SELECTOR = '.slides section',
31
	var SLIDES_SELECTOR = '.slides section',
3980
32
		HORIZONTAL_SLIDES_SELECTOR = '.slides>section',
32
		HORIZONTAL_SLIDES_SELECTOR = '.slides>section',
3981
@@ -67,16 +67,36 @@
3982
67
			progress: true,
67
			progress: true,
3983
68
68
3984
69
			// Display the page number of the current slide
69
			// Display the page number of the current slide
3985
70
			// - true:    Show slide number
3986
71
			// - false:   Hide slide number
3987
72
			//
3988
73
			// Can optionally be set as a string that specifies the number formatting:
3989
74
			// - "h.v":	  Horizontal . vertical slide number (default)
3990
75
			// - "h/v":	  Horizontal / vertical slide number
3991
76
			// - "c":	  Flattened slide number
3992
77
			// - "c/t":	  Flattened slide number / total slides
3993
78
			//
3994
79
			// Alternatively, you can provide a function that returns the slide
3995
80
			// number for the current slide. The function needs to return an array
3996
81
			// with one string [slideNumber] or three strings [n1,delimiter,n2].
3997
82
			// See #formatSlideNumber().
3998
70
			slideNumber: false,
83
			slideNumber: false,
3999
71
84
4000
85
			// Can be used to limit the contexts in which the slide number appears
4001
86
			// - "all":      Always show the slide number
4002
87
			// - "print":    Only when printing to PDF
4003
88
			// - "speaker":  Only in the speaker view
4004
89
			showSlideNumber: 'all',
4005
90
4006
72
			// Use 1 based indexing for # links to match slide number (default is zero
91
			// Use 1 based indexing for # links to match slide number (default is zero
4007
73
			// based)
92
			// based)
4008
74
			hashOneBasedIndex: false,
93
			hashOneBasedIndex: false,
4009
75
94
4012
76
			// Determine which displays to show the slide number on
95
			// Add the current slide number to the URL hash so that reloading the
4013
77
			showSlideNumber: 'all',
96
			// page/copying the URL will return you to the same slide
4014
97
			hash: false,
4015
78
98
4017
79
			// Push each slide change to the browser history
99
			// Push each slide change to the browser history.  Implies `hash: true`
4018
80
			history: false,
100
			history: false,
4019
81
101
4020
82
			// Enable keyboard shortcuts for navigation
102
			// Enable keyboard shortcuts for navigation
4021
@@ -104,6 +124,32 @@
4022
104
			// Change the presentation direction to be RTL
124
			// Change the presentation direction to be RTL
4023
105
			rtl: false,
125
			rtl: false,
4024
106
126
4025
127
			// Changes the behavior of our navigation directions.
4026
128
			//
4027
129
			// "default"
4028
130
			// Left/right arrow keys step between horizontal slides, up/down
4029
131
			// arrow keys step between vertical slides. Space key steps through
4030
132
			// all slides (both horizontal and vertical).
4031
133
			//
4032
134
			// "linear"
4033
135
			// Removes the up/down arrows. Left/right arrows step through all
4034
136
			// slides (both horizontal and vertical).
4035
137
			//
4036
138
			// "grid"
4037
139
			// When this is enabled, stepping left/right from a vertical stack
4038
140
			// to an adjacent vertical stack will land you at the same vertical
4039
141
			// index.
4040
142
			//
4041
143
			// Consider a deck with six slides ordered in two vertical stacks:
4042
144
			// 1.1    2.1
4043
145
			// 1.2    2.2
4044
146
			// 1.3    2.3
4045
147
			//
4046
148
			// If you're on slide 1.3 and navigate right, you will normally move
4047
149
			// from 1.3 -> 2.1. If "grid" is used, the same navigation takes you
4048
150
			// from 1.3 -> 2.3.
4049
151
			navigationMode: 'default',
4050
152
4051
107
			// Randomizes the order of slides each time the presentation loads
153
			// Randomizes the order of slides each time the presentation loads
4052
108
			shuffle: false,
154
			shuffle: false,
4053
109
155
4054
@@ -134,6 +180,13 @@
4055
134
			// - false:  No media will autoplay, regardless of individual setting
180
			// - false:  No media will autoplay, regardless of individual setting
4056
135
			autoPlayMedia: null,
181
			autoPlayMedia: null,
4057
136
182
4058
183
			// Global override for preloading lazy-loaded iframes
4059
184
			// - null:   Iframes with data-src AND data-preload will be loaded when within
4060
185
			//           the viewDistance, iframes with only data-src will be loaded when visible
4061
186
			// - true:   All iframes with data-src will be loaded when within the viewDistance
4062
187
			// - false:  All iframes with data-src will be loaded only when visible
4063
188
			preloadIframes: null,
4064
189
4065
137
			// Controls automatic progression to the next slide
190
			// Controls automatic progression to the next slide
4066
138
			// - 0:      Auto-sliding only happens if the data-autoslide HTML attribute
191
			// - 0:      Auto-sliding only happens if the data-autoslide HTML attribute
4067
139
			//           is present on the current slide or fragment
192
			//           is present on the current slide or fragment
4068
@@ -220,6 +273,12 @@
4069
220
			// The display mode that will be used to show slides
273
			// The display mode that will be used to show slides
4070
221
			display: 'block',
274
			display: 'block',
4071
222
275
4072
276
			// Hide cursor if inactive
4073
277
			hideInactiveCursor: true,
4074
278
4075
279
			// Time before the cursor is hidden (in ms)
4076
280
			hideCursorTime: 5000,
4077
281
4078
223
			// Script dependencies to load
282
			// Script dependencies to load
4079
224
			dependencies: []
283
			dependencies: []
4080
225
284
4081
@@ -267,6 +326,12 @@
4082
267
		// Cached references to DOM elements
326
		// Cached references to DOM elements
4083
268
		dom = {},
327
		dom = {},
4084
269
328
4085
329
		// A list of registered reveal.js plugins
4086
330
		plugins = {},
4087
331
4088
332
		// List of asynchronously loaded reveal.js dependencies
4089
333
		asyncDependencies = [],
4090
334
4091
270
		// Features supported by the browser, see #checkCapabilities()
335
		// Features supported by the browser, see #checkCapabilities()
4092
271
		features = {},
336
		features = {},
4093
272
337
4094
@@ -282,6 +347,12 @@
4095
282
		// Delays updates to the URL due to a Chrome thumbnailer bug
347
		// Delays updates to the URL due to a Chrome thumbnailer bug
4096
283
		writeURLTimeout = 0,
348
		writeURLTimeout = 0,
4097
284
349
4098
350
		// Is the mouse pointer currently hidden from view
4099
351
		cursorHidden = false,
4100
352
4101
353
		// Timeout used to determine when the cursor is inactive
4102
354
		cursorInactiveTimeout = 0,
4103
355
4104
285
		// Flags if the interaction event listeners are bound
356
		// Flags if the interaction event listeners are bound
4105
286
		eventsAreBound = false,
357
		eventsAreBound = false,
4106
287
358
4107
@@ -298,26 +369,14 @@
4108
298
		touch = {
369
		touch = {
4109
299
			startX: 0,
370
			startX: 0,
4110
300
			startY: 0,
371
			startY: 0,
4111
301
			startSpan: 0,
4112
302
			startCount: 0,
372
			startCount: 0,
4113
303
			captured: false,
373
			captured: false,
4114
304
			threshold: 40
374
			threshold: 40
4115
305
		},
375
		},
4116
306
376
4131
307
		// Holds information about the keyboard shortcuts
377
		// A key:value map of shortcut keyboard keys and descriptions of
4132
308
		keyboardShortcuts = {
378
		// the actions they trigger, generated in #configure()
4133
309
			'N  ,  SPACE':			'Next slide',
379
		keyboardShortcuts = {},
4120
310
			'P':					'Previous slide',
4121
311
			'&#8592;  ,  H':		'Navigate left',
4122
312
			'&#8594;  ,  L':		'Navigate right',
4123
313
			'&#8593;  ,  K':		'Navigate up',
4124
314
			'&#8595;  ,  J':		'Navigate down',
4125
315
			'Home':					'First slide',
4126
316
			'End':					'Last slide',
4127
317
			'B  ,  .':				'Pause',
4128
318
			'F':					'Fullscreen',
4129
319
			'ESC, O':				'Slide overview'
4130
320
		},
4134
321
380
4135
322
		// Holds custom key code mappings
381
		// Holds custom key code mappings
4136
323
		registeredKeyBindings = {};
382
		registeredKeyBindings = {};
4137
@@ -377,7 +436,7 @@
4138
377
		// Hide the address bar in mobile browsers
436
		// Hide the address bar in mobile browsers
4139
378
		hideAddressBar();
437
		hideAddressBar();
4140
379
438
4142
380
		// Loads the dependencies and continues to #start() once done
439
		// Loads dependencies and continues to #start() once done
4143
381
		load();
440
		load();
4144
382
441
4145
383
	}
442
	}
4146
@@ -440,57 +499,148 @@
4147
440
	function load() {
499
	function load() {
4148
441
500
4149
442
		var scripts = [],
501
		var scripts = [],
4179
443
			scriptsAsync = [],
502
			scriptsToLoad = 0;
4180
444
			scriptsToPreload = 0;
503
4181
445
504
		config.dependencies.forEach( function( s ) {
4153
446
		// Called once synchronous scripts finish loading
4154
447
		function proceed() {
4155
448
			if( scriptsAsync.length ) {
4156
449
				// Load asynchronous scripts
4157
450
				head.js.apply( null, scriptsAsync );
4158
451
			}
4159
452
4160
453
			start();
4161
454
		}
4162
455
4163
456
		function loadScript( s ) {
4164
457
			head.ready( s.src.match( /([\w\d_\-]*)\.?js(\?[\w\d.=&]*)?$|[^\\\/]*$/i )[0], function() {
4165
458
				// Extension may contain callback functions
4166
459
				if( typeof s.callback === 'function' ) {
4167
460
					s.callback.apply( this );
4168
461
				}
4169
462
4170
463
				if( --scriptsToPreload === 0 ) {
4171
464
					proceed();
4172
465
				}
4173
466
			});
4174
467
		}
4175
468
4176
469
		for( var i = 0, len = config.dependencies.length; i < len; i++ ) {
4177
470
			var s = config.dependencies[i];
4178
471
4182
472
			// Load if there's no condition or the condition is truthy
505
			// Load if there's no condition or the condition is truthy
4183
473
			if( !s.condition || s.condition() ) {
506
			if( !s.condition || s.condition() ) {
4184
474
				if( s.async ) {
507
				if( s.async ) {
4186
475
					scriptsAsync.push( s.src );
508
					asyncDependencies.push( s );
4187
476
				}
509
				}
4188
477
				else {
510
				else {
4190
478
					scripts.push( s.src );
511
					scripts.push( s );
4191
479
				}
512
				}
4192
480
4193
481
				loadScript( s );
4194
482
			}
513
			}
4196
483
		}
514
		} );
4197
484
515
4198
485
		if( scripts.length ) {
516
		if( scripts.length ) {
4200
486
			scriptsToPreload = scripts.length;
517
			scriptsToLoad = scripts.length;
4201
487
518
4202
488
			// Load synchronous scripts
519
			// Load synchronous scripts
4208
489
			head.js.apply( null, scripts );
520
			scripts.forEach( function( s ) {
4209
490
		}
521
				loadScript( s.src, function() {
4210
491
		else {
522
4211
492
			proceed();
523
					if( typeof s.callback === 'function' ) s.callback();
4212
493
		}
524
4213
525
					if( --scriptsToLoad === 0 ) {
4214
526
						initPlugins();
4215
527
					}
4216
528
4217
529
				} );
4218
530
			} );
4219
531
		}
4220
532
		else {
4221
533
			initPlugins();
4222
534
		}
4223
535
4224
536
	}
4225
537
4226
538
	/**
4227
539
	 * Initializes our plugins and waits for them to be ready
4228
540
	 * before proceeding.
4229
541
	 */
4230
542
	function initPlugins() {
4231
543
4232
544
		var pluginsToInitialize = Object.keys( plugins ).length;
4233
545
4234
546
		// If there are no plugins, skip this step
4235
547
		if( pluginsToInitialize === 0 ) {
4236
548
			loadAsyncDependencies();
4237
549
		}
4238
550
		// ... otherwise initialize plugins
4239
551
		else {
4240
552
4241
553
			var afterPlugInitialized = function() {
4242
554
				if( --pluginsToInitialize === 0 ) {
4243
555
					loadAsyncDependencies();
4244
556
				}
4245
557
			};
4246
558
4247
559
			for( var i in plugins ) {
4248
560
4249
561
				var plugin = plugins[i];
4250
562
4251
563
				// If the plugin has an 'init' method, invoke it
4252
564
				if( typeof plugin.init === 'function' ) {
4253
565
					var callback = plugin.init();
4254
566
4255
567
					// If the plugin returned a Promise, wait for it
4256
568
					if( callback && typeof callback.then === 'function' ) {
4257
569
						callback.then( afterPlugInitialized );
4258
570
					}
4259
571
					else {
4260
572
						afterPlugInitialized();
4261
573
					}
4262
574
				}
4263
575
				else {
4264
576
					afterPlugInitialized();
4265
577
				}
4266
578
4267
579
			}
4268
580
4269
581
		}
4270
582
4271
583
	}
4272
584
4273
585
	/**
4274
586
	 * Loads all async reveal.js dependencies.
4275
587
	 */
4276
588
	function loadAsyncDependencies() {
4277
589
4278
590
		if( asyncDependencies.length ) {
4279
591
			asyncDependencies.forEach( function( s ) {
4280
592
				loadScript( s.src, s.callback );
4281
593
			} );
4282
594
		}
4283
595
4284
596
		start();
4285
597
4286
598
	}
4287
599
4288
600
	/**
4289
601
	 * Loads a JavaScript file from the given URL and executes it.
4290
602
	 *
4291
603
	 * @param {string} url Address of the .js file to load
4292
604
	 * @param {function} callback Method to invoke when the script
4293
605
	 * has loaded and executed
4294
606
	 */
4295
607
	function loadScript( url, callback ) {
4296
608
4297
609
		var script = document.createElement( 'script' );
4298
610
		script.type = 'text/javascript';
4299
611
		script.async = false;
4300
612
		script.defer = false;
4301
613
		script.src = url;
4302
614
4303
615
		if( callback ) {
4304
616
4305
617
			// Success callback
4306
618
			script.onload = script.onreadystatechange = function( event ) {
4307
619
				if( event.type === "load" || (/loaded|complete/.test( script.readyState ) ) ) {
4308
620
4309
621
					// Kill event listeners
4310
622
					script.onload = script.onreadystatechange = script.onerror = null;
4311
623
4312
624
					callback();
4313
625
4314
626
				}
4315
627
			};
4316
628
4317
629
			// Error callback
4318
630
			script.onerror = function( err ) {
4319
631
4320
632
				// Kill event listeners
4321
633
				script.onload = script.onreadystatechange = script.onerror = null;
4322
634
4323
635
				callback( new Error( 'Failed loading script: ' + script.src + '\n' + err) );
4324
636
4325
637
			};
4326
638
4327
639
		}
4328
640
4329
641
		// Append the script at the end of <head>
4330
642
		var head = document.querySelector( 'head' );
4331
643
		head.insertBefore( script, head.lastChild );
4332
494
644
4333
495
	}
645
	}
4334
496
646
4335
@@ -601,8 +751,7 @@
4336
601
		dom.speakerNotes.setAttribute( 'tabindex', '0' );
751
		dom.speakerNotes.setAttribute( 'tabindex', '0' );
4337
602
752
4338
603
		// Overlay graphic which is displayed during the paused mode
753
		// Overlay graphic which is displayed during the paused mode
4341
604
		dom.pauseOverlay = createSingletonNode( dom.wrapper, 'div', 'pause-overlay', '<button class="resume-button">Resume presentation</button>' );
754
		dom.pauseOverlay = createSingletonNode( dom.wrapper, 'div', 'pause-overlay', config.controls ? '<button class="resume-button">Resume presentation</button>' : null );
4340
605
		dom.resumeButton = dom.pauseOverlay.querySelector( '.resume-button' );
4342
606
755
4343
607
		dom.wrapper.setAttribute( 'role', 'application' );
756
		dom.wrapper.setAttribute( 'role', 'application' );
4344
608
757
4345
@@ -1082,18 +1231,27 @@
4346
1082
		if( data.backgroundPosition ) contentElement.style.backgroundPosition = data.backgroundPosition;
1231
		if( data.backgroundPosition ) contentElement.style.backgroundPosition = data.backgroundPosition;
4347
1083
		if( data.backgroundOpacity ) contentElement.style.opacity = data.backgroundOpacity;
1232
		if( data.backgroundOpacity ) contentElement.style.opacity = data.backgroundOpacity;
4348
1084
1233
4350
1085
		// If this slide has a background color, add a class that
1234
		// If this slide has a background color, we add a class that
4351
1086
		// signals if it is light or dark. If the slide has no background
1235
		// signals if it is light or dark. If the slide has no background
4356
1087
		// color, no class will be set
1236
		// color, no class will be added
4357
1088
		var computedBackgroundStyle = window.getComputedStyle( element );
1237
		var contrastColor = data.backgroundColor;
4358
1089
		if( computedBackgroundStyle && computedBackgroundStyle.backgroundColor ) {
1238
4359
1090
			var rgb = colorToRgb( computedBackgroundStyle.backgroundColor );
1239
		// If no bg color was found, check the computed background
4360
1240
		if( !contrastColor ) {
4361
1241
			var computedBackgroundStyle = window.getComputedStyle( element );
4362
1242
			if( computedBackgroundStyle && computedBackgroundStyle.backgroundColor ) {
4363
1243
				contrastColor = computedBackgroundStyle.backgroundColor;
4364
1244
			}
4365
1245
		}
4366
1246
4367
1247
		if( contrastColor ) {
4368
1248
			var rgb = colorToRgb( contrastColor );
4369
1091
1249
4370
1092
			// Ignore fully transparent backgrounds. Some browsers return
1250
			// Ignore fully transparent backgrounds. Some browsers return
4371
1093
			// rgba(0,0,0,0) when reading the computed background color of
1251
			// rgba(0,0,0,0) when reading the computed background color of
4372
1094
			// an element with no background
1252
			// an element with no background
4373
1095
			if( rgb && rgb.a !== 0 ) {
1253
			if( rgb && rgb.a !== 0 ) {
4375
1096
				if( colorBrightness( computedBackgroundStyle.backgroundColor ) < 128 ) {
1254
				if( colorBrightness( contrastColor ) < 128 ) {
4376
1097
					slide.classList.add( 'has-dark-background' );
1255
					slide.classList.add( 'has-dark-background' );
4377
1098
				}
1256
				}
4378
1099
				else {
1257
				else {
4379
@@ -1216,6 +1374,18 @@
4380
1216
			disableRollingLinks();
1374
			disableRollingLinks();
4381
1217
		}
1375
		}
4382
1218
1376
4383
1377
		// Auto-hide the mouse pointer when its inactive
4384
1378
		if( config.hideInactiveCursor ) {
4385
1379
			document.addEventListener( 'mousemove', onDocumentCursorActive, false );
4386
1380
			document.addEventListener( 'mousedown', onDocumentCursorActive, false );
4387
1381
		}
4388
1382
		else {
4389
1383
			showCursor();
4390
1384
4391
1385
			document.removeEventListener( 'mousemove', onDocumentCursorActive, false );
4392
1386
			document.removeEventListener( 'mousedown', onDocumentCursorActive, false );
4393
1387
		}
4394
1388
4395
1219
		// Iframe link previews
1389
		// Iframe link previews
4396
1220
		if( config.previewLinks ) {
1390
		if( config.previewLinks ) {
4397
1221
			enablePreviewLinks();
1391
			enablePreviewLinks();
4398
@@ -1263,6 +1433,34 @@
4399
1263
1433
4400
1264
		dom.slideNumber.style.display = slideNumberDisplay;
1434
		dom.slideNumber.style.display = slideNumberDisplay;
4401
1265
1435
4402
1436
		// Add the navigation mode to the DOM so we can adjust styling
4403
1437
		if( config.navigationMode !== 'default' ) {
4404
1438
			dom.wrapper.setAttribute( 'data-navigation-mode', config.navigationMode );
4405
1439
		}
4406
1440
		else {
4407
1441
			dom.wrapper.removeAttribute( 'data-navigation-mode' );
4408
1442
		}
4409
1443
4410
1444
		// Define our contextual list of keyboard shortcuts
4411
1445
		if( config.navigationMode === 'linear' ) {
4412
1446
			keyboardShortcuts['&#8594;  ,  &#8595;  ,  SPACE  ,  N  ,  L  ,  J'] = 'Next slide';
4413
1447
			keyboardShortcuts['&#8592;  ,  &#8593;  ,  P  ,  H  ,  K']           = 'Previous slide';
4414
1448
		}
4415
1449
		else {
4416
1450
			keyboardShortcuts['N  ,  SPACE']   = 'Next slide';
4417
1451
			keyboardShortcuts['P']             = 'Previous slide';
4418
1452
			keyboardShortcuts['&#8592;  ,  H'] = 'Navigate left';
4419
1453
			keyboardShortcuts['&#8594;  ,  L'] = 'Navigate right';
4420
1454
			keyboardShortcuts['&#8593;  ,  K'] = 'Navigate up';
4421
1455
			keyboardShortcuts['&#8595;  ,  J'] = 'Navigate down';
4422
1456
		}
4423
1457
4424
1458
		keyboardShortcuts['Home  ,  &#8984;/CTRL &#8592;'] = 'First slide';
4425
1459
		keyboardShortcuts['End  ,  &#8984;/CTRL &#8594;']  = 'Last slide';
4426
1460
		keyboardShortcuts['B  ,  .']                       = 'Pause';
4427
1461
		keyboardShortcuts['F']                             = 'Fullscreen';
4428
1462
		keyboardShortcuts['ESC, O']                        = 'Slide overview';
4429
1463
4430
1266
		sync();
1464
		sync();
4431
1267
1465
4432
1268
	}
1466
	}
4433
@@ -1307,7 +1505,7 @@
4434
1307
			dom.progress.addEventListener( 'click', onProgressClicked, false );
1505
			dom.progress.addEventListener( 'click', onProgressClicked, false );
4435
1308
		}
1506
		}
4436
1309
1507
4438
1310
		dom.resumeButton.addEventListener( 'click', resume, false );
1508
		dom.pauseOverlay.addEventListener( 'click', resume, false );
4439
1311
1509
4440
1312
		if( config.focusBodyOnPageVisibilityChange ) {
1510
		if( config.focusBodyOnPageVisibilityChange ) {
4441
1313
			var visibilityChange;
1511
			var visibilityChange;
4442
@@ -1372,7 +1570,7 @@
4443
1372
		dom.wrapper.removeEventListener( 'touchmove', onTouchMove, false );
1570
		dom.wrapper.removeEventListener( 'touchmove', onTouchMove, false );
4444
1373
		dom.wrapper.removeEventListener( 'touchend', onTouchEnd, false );
1571
		dom.wrapper.removeEventListener( 'touchend', onTouchEnd, false );
4445
1374
1572
4447
1375
		dom.resumeButton.removeEventListener( 'click', resume, false );
1573
		dom.pauseOverlay.removeEventListener( 'click', resume, false );
4448
1376
1574
4449
1377
		if ( config.progress && dom.progress ) {
1575
		if ( config.progress && dom.progress ) {
4450
1378
			dom.progress.removeEventListener( 'click', onProgressClicked, false );
1576
			dom.progress.removeEventListener( 'click', onProgressClicked, false );
4451
@@ -1390,6 +1588,53 @@
4452
1390
	}
1588
	}
4453
1391
1589
4454
1392
	/**
1590
	/**
4455
1591
	 * Registers a new plugin with this reveal.js instance.
4456
1592
	 *
4457
1593
	 * reveal.js waits for all regisered plugins to initialize
4458
1594
	 * before considering itself ready, as long as the plugin
4459
1595
	 * is registered before calling `Reveal.initialize()`.
4460
1596
	 */
4461
1597
	function registerPlugin( id, plugin ) {
4462
1598
4463
1599
		if( plugins[id] === undefined ) {
4464
1600
			plugins[id] = plugin;
4465
1601
4466
1602
			// If a plugin is registered after reveal.js is loaded,
4467
1603
			// initialize it right away
4468
1604
			if( loaded && typeof plugin.init === 'function' ) {
4469
1605
				plugin.init();
4470
1606
			}
4471
1607
		}
4472
1608
		else {
4473
1609
			console.warn( 'reveal.js: "'+ id +'" plugin has already been registered' );
4474
1610
		}
4475
1611
4476
1612
	}
4477
1613
4478
1614
	/**
4479
1615
	 * Checks if a specific plugin has been registered.
4480
1616
	 *
4481
1617
	 * @param {String} id Unique plugin identifier
4482
1618
	 */
4483
1619
	function hasPlugin( id ) {
4484
1620
4485
1621
		return !!plugins[id];
4486
1622
4487
1623
	}
4488
1624
4489
1625
	/**
4490
1626
	 * Returns the specific plugin instance, if a plugin
4491
1627
	 * with the given ID has been registered.
4492
1628
	 *
4493
1629
	 * @param {String} id Unique plugin identifier
4494
1630
	 */
4495
1631
	function getPlugin( id ) {
4496
1632
4497
1633
		return plugins[id];
4498
1634
4499
1635
	}
4500
1636
4501
1637
	/**
4502
1393
	 * Add a custom key binding with optional description to
1638
	 * Add a custom key binding with optional description to
4503
1394
	 * be added to the help screen.
1639
	 * be added to the help screen.
4504
1395
	 */
1640
	 */
4505
@@ -1677,11 +1922,19 @@
4506
1677
			// Change the .stretch element height to 0 in order find the height of all
1922
			// Change the .stretch element height to 0 in order find the height of all
4507
1678
			// the other elements
1923
			// the other elements
4508
1679
			element.style.height = '0px';
1924
			element.style.height = '0px';
4509
1925
4510
1926
			// In Overview mode, the parent (.slide) height is set of 700px.
4511
1927
			// Restore it temporarily to its natural height.
4512
1928
			element.parentNode.style.height = 'auto';
4513
1929
4514
1680
			newHeight = height - element.parentNode.offsetHeight;
1930
			newHeight = height - element.parentNode.offsetHeight;
4515
1681
1931
4516
1682
			// Restore the old height, just in case
1932
			// Restore the old height, just in case
4517
1683
			element.style.height = oldHeight + 'px';
1933
			element.style.height = oldHeight + 'px';
4518
1684
1934
4519
1935
			// Clear the parent (.slide) height. .removeProperty works in IE9+
4520
1936
			element.parentNode.style.removeProperty('height');
4521
1937
4522
1685
			return newHeight;
1938
			return newHeight;
4523
1686
		}
1939
		}
4524
1687
1940
4525
@@ -1699,15 +1952,6 @@
4526
1699
	}
1952
	}
4527
1700
1953
4528
1701
	/**
1954
	/**
4529
1702
	 * Check if this instance is being used to print a PDF with fragments.
4530
1703
	 */
4531
1704
	function isPrintingPDFFragments() {
4532
1705
4533
1706
		return ( /print-pdf-fragments/gi ).test( window.location.search );
4534
1707
4535
1708
	}
4536
1709
4537
1710
	/**
4538
1711
	 * Hides the address bar if we're on a mobile device.
1955
	 * Hides the address bar if we're on a mobile device.
4539
1712
	 */
1956
	 */
4540
1713
	function hideAddressBar() {
1957
	function hideAddressBar() {
4541
@@ -1970,8 +2214,20 @@
4542
1970
2214
4543
1971
			if( !config.disableLayout ) {
2215
			if( !config.disableLayout ) {
4544
1972
2216
4545
2217
				// On some mobile devices '100vh' is taller than the visible
4546
2218
				// viewport which leads to part of the presentation being
4547
2219
				// cut off. To work around this we define our own '--vh' custom
4548
2220
				// property where 100x adds up to the correct height.
4549
2221
				//
4550
2222
				// https://css-tricks.com/the-trick-to-viewport-units-on-mobile/
4551
2223
				if( isMobileDevice ) {
4552
2224
					document.documentElement.style.setProperty( '--vh', ( window.innerHeight * 0.01 ) + 'px' );
4553
2225
				}
4554
2226
4555
1973
				var size = getComputedSlideSize();
2227
				var size = getComputedSlideSize();
4556
1974
2228
4557
2229
				var oldScale = scale;
4558
2230
4559
1975
				// Layout the contents of the slides
2231
				// Layout the contents of the slides
4560
1976
				layoutSlideContents( config.width, config.height );
2232
				layoutSlideContents( config.width, config.height );
4561
1977
2233
4562
@@ -2044,6 +2300,13 @@
4563
2044
2300
4564
2045
				}
2301
				}
4565
2046
2302
4566
2303
				if( oldScale !== scale ) {
4567
2304
					dispatchEvent( 'resize', {
4568
2305
						'oldScale': oldScale,
4569
2306
						'scale': scale,
4570
2307
						'size': size
4571
2308
					} );
4572
2309
				}
4573
2047
			}
2310
			}
4574
2048
2311
4575
2049
			updateProgress();
2312
			updateProgress();
4576
@@ -2443,6 +2706,32 @@
4577
2443
	}
2706
	}
4578
2444
2707
4579
2445
	/**
2708
	/**
4580
2709
	 * Shows the mouse pointer after it has been hidden with
4581
2710
	 * #hideCursor.
4582
2711
	 */
4583
2712
	function showCursor() {
4584
2713
4585
2714
		if( cursorHidden ) {
4586
2715
			cursorHidden = false;
4587
2716
			dom.wrapper.style.cursor = '';
4588
2717
		}
4589
2718
4590
2719
	}
4591
2720
4592
2721
	/**
4593
2722
	 * Hides the mouse pointer when it's on top of the .reveal
4594
2723
	 * container.
4595
2724
	 */
4596
2725
	function hideCursor() {
4597
2726
4598
2727
		if( cursorHidden === false ) {
4599
2728
			cursorHidden = true;
4600
2729
			dom.wrapper.style.cursor = 'none';
4601
2730
		}
4602
2731
4603
2732
	}
4604
2733
4605
2734
	/**
4606
2446
	 * Enters the paused mode which fades everything on screen to
2735
	 * Enters the paused mode which fades everything on screen to
4607
2447
	 * black.
2736
	 * black.
4608
2448
	 */
2737
	 */
4609
@@ -2584,28 +2873,6 @@
4610
2584
2873
4611
2585
		layout();
2874
		layout();
4612
2586
2875
4613
2587
		// Apply the new state
4614
2588
		stateLoop: for( var i = 0, len = state.length; i < len; i++ ) {
4615
2589
			// Check if this state existed on the previous slide. If it
4616
2590
			// did, we will avoid adding it repeatedly
4617
2591
			for( var j = 0; j < stateBefore.length; j++ ) {
4618
2592
				if( stateBefore[j] === state[i] ) {
4619
2593
					stateBefore.splice( j, 1 );
4620
2594
					continue stateLoop;
4621
2595
				}
4622
2596
			}
4623
2597
4624
2598
			document.documentElement.classList.add( state[i] );
4625
2599
4626
2600
			// Dispatch custom event matching the state's name
4627
2601
			dispatchEvent( state[i] );
4628
2602
		}
4629
2603
4630
2604
		// Clean up the remains of the previous state
4631
2605
		while( stateBefore.length ) {
4632
2606
			document.documentElement.classList.remove( stateBefore.pop() );
4633
2607
		}
4634
2608
4635
2609
		// Update the overview if it's currently active
2876
		// Update the overview if it's currently active
4636
2610
		if( isOverview() ) {
2877
		if( isOverview() ) {
4637
2611
			updateOverview();
2878
			updateOverview();
4638
@@ -2654,6 +2921,28 @@
4639
2654
			}
2921
			}
4640
2655
		}
2922
		}
4641
2656
2923
4642
2924
		// Apply the new state
4643
2925
		stateLoop: for( var i = 0, len = state.length; i < len; i++ ) {
4644
2926
			// Check if this state existed on the previous slide. If it
4645
2927
			// did, we will avoid adding it repeatedly
4646
2928
			for( var j = 0; j < stateBefore.length; j++ ) {
4647
2929
				if( stateBefore[j] === state[i] ) {
4648
2930
					stateBefore.splice( j, 1 );
4649
2931
					continue stateLoop;
4650
2932
				}
4651
2933
			}
4652
2934
4653
2935
			document.documentElement.classList.add( state[i] );
4654
2936
4655
2937
			// Dispatch custom event matching the state's name
4656
2938
			dispatchEvent( state[i] );
4657
2939
		}
4658
2940
4659
2941
		// Clean up the remains of the previous state
4660
2942
		while( stateBefore.length ) {
4661
2943
			document.documentElement.classList.remove( stateBefore.pop() );
4662
2944
		}
4663
2945
4664
2657
		if( slideChanged ) {
2946
		if( slideChanged ) {
4665
2658
			dispatchEvent( 'slidechanged', {
2947
			dispatchEvent( 'slidechanged', {
4666
2659
				'indexh': indexh,
2948
				'indexh': indexh,
4667
@@ -2679,6 +2968,7 @@
4668
2679
		updateParallax();
2968
		updateParallax();
4669
2680
		updateSlideNumber();
2969
		updateSlideNumber();
4670
2681
		updateNotes();
2970
		updateNotes();
4671
2971
		updateFragments();
4672
2682
2972
4673
2683
		// Update the URL hash
2973
		// Update the URL hash
4674
2684
		writeURL();
2974
		writeURL();
4675
@@ -2751,6 +3041,9 @@
4676
2751
	 */
3041
	 */
4677
2752
	function syncSlide( slide ) {
3042
	function syncSlide( slide ) {
4678
2753
3043
4679
3044
		// Default to the current slide
4680
3045
		slide = slide || currentSlide;
4681
3046
4682
2754
		syncBackground( slide );
3047
		syncBackground( slide );
4683
2755
		syncFragments( slide );
3048
		syncFragments( slide );
4684
2756
3049
4685
@@ -2767,10 +3060,14 @@
4686
2767
	 * after reveal.js has already initialized.
3060
	 * after reveal.js has already initialized.
4687
2768
	 *
3061
	 *
4688
2769
	 * @param {HTMLElement} slide
3062
	 * @param {HTMLElement} slide
4689
3063
	 * @return {Array} a list of the HTML fragments that were synced
4690
2770
	 */
3064
	 */
4691
2771
	function syncFragments( slide ) {
3065
	function syncFragments( slide ) {
4692
2772
3066
4694
2773
		sortFragments( slide.querySelectorAll( '.fragment' ) );
3067
		// Default to the current slide
4695
3068
		slide = slide || currentSlide;
4696
3069
4697
3070
		return sortFragments( slide.querySelectorAll( '.fragment' ) );
4698
2774
3071
4699
2775
	}
3072
	}
4700
2776
3073
4701
@@ -2903,14 +3200,11 @@
4702
2903
					element.classList.add( reverse ? 'future' : 'past' );
3200
					element.classList.add( reverse ? 'future' : 'past' );
4703
2904
3201
4704
2905
					if( config.fragments ) {
3202
					if( config.fragments ) {
4713
2906
						var pastFragments = toArray( element.querySelectorAll( '.fragment' ) );
3203
						// Show all fragments in prior slides
4714
2907
3204
						toArray( element.querySelectorAll( '.fragment' ) ).forEach( function( fragment ) {
4715
2908
						// Show all fragments on prior slides
3205
							fragment.classList.add( 'visible' );
4716
2909
						while( pastFragments.length ) {
3206
							fragment.classList.remove( 'current-fragment' );
4717
2910
							var pastFragment = pastFragments.pop();
3207
						} );
4710
2911
							pastFragment.classList.add( 'visible' );
4711
2912
							pastFragment.classList.remove( 'current-fragment' );
4712
2913
						}
4718
2914
					}
3208
					}
4719
2915
				}
3209
				}
4720
2916
				else if( i > index ) {
3210
				else if( i > index ) {
4721
@@ -2918,14 +3212,11 @@
4722
2918
					element.classList.add( reverse ? 'past' : 'future' );
3212
					element.classList.add( reverse ? 'past' : 'future' );
4723
2919
3213
4724
2920
					if( config.fragments ) {
3214
					if( config.fragments ) {
4733
2921
						var futureFragments = toArray( element.querySelectorAll( '.fragment.visible' ) );
3215
						// Hide all fragments in future slides
4734
2922
3216
						toArray( element.querySelectorAll( '.fragment.visible' ) ).forEach( function( fragment ) {
4735
2923
						// No fragments in future slides should be visible ahead of time
3217
							fragment.classList.remove( 'visible' );
4736
2924
						while( futureFragments.length ) {
3218
							fragment.classList.remove( 'current-fragment' );
4737
2925
							var futureFragment = futureFragments.pop();
3219
						} );
4730
2926
							futureFragment.classList.remove( 'visible' );
4731
2927
							futureFragment.classList.remove( 'current-fragment' );
4732
2928
						}
4738
2929
					}
3220
					}
4739
2930
				}
3221
				}
4740
2931
			}
3222
			}
4741
@@ -3104,47 +3395,47 @@
4742
3104
3395
4743
3105
3396
4744
3106
	/**
3397
	/**
4752
3107
	 * Updates the slide number div to reflect the current slide.
3398
	 * Updates the slide number to match the current slide.
4746
3108
	 *
4747
3109
	 * The following slide number formats are available:
4748
3110
	 *  "h.v":	horizontal . vertical slide number (default)
4749
3111
	 *  "h/v":	horizontal / vertical slide number
4750
3112
	 *    "c":	flattened slide number
4751
3113
	 *  "c/t":	flattened slide number / total slides
4753
3114
	 */
3399
	 */
4754
3115
	function updateSlideNumber() {
3400
	function updateSlideNumber() {
4755
3116
3401
4756
3117
		// Update slide number if enabled
3402
		// Update slide number if enabled
4757
3118
		if( config.slideNumber && dom.slideNumber ) {
3403
		if( config.slideNumber && dom.slideNumber ) {
4758
3119
3404
4760
3120
			var value = [];
3405
			var value;
4761
3121
			var format = 'h.v';
3406
			var format = 'h.v';
4762
3122
3407
4788
3123
			// Check if a custom number format is available
3408
			if( typeof config.slideNumber === 'function' ) {
4789
3124
			if( typeof config.slideNumber === 'string' ) {
3409
				value = config.slideNumber();
4790
3125
				format = config.slideNumber;
3410
			}
4791
3126
			}
3411
			else {
4792
3127
3412
				// Check if a custom number format is available
4793
3128
			// If there are ONLY vertical slides in this deck, always use
3413
				if( typeof config.slideNumber === 'string' ) {
4794
3129
			// a flattened slide number
3414
					format = config.slideNumber;
4795
3130
			if( !/c/.test( format ) && dom.wrapper.querySelectorAll( HORIZONTAL_SLIDES_SELECTOR ).length === 1 ) {
3415
				}
4796
3131
				format = 'c';
3416
4797
3132
			}
3417
				// If there are ONLY vertical slides in this deck, always use
4798
3133
3418
				// a flattened slide number
4799
3134
			switch( format ) {
3419
				if( !/c/.test( format ) && dom.wrapper.querySelectorAll( HORIZONTAL_SLIDES_SELECTOR ).length === 1 ) {
4800
3135
				case 'c':
3420
					format = 'c';
4801
3136
					value.push( getSlidePastCount() + 1 );
3421
				}
4802
3137
					break;
3422
4803
3138
				case 'c/t':
3423
				value = [];
4804
3139
					value.push( getSlidePastCount() + 1, '/', getTotalSlides() );
3424
				switch( format ) {
4805
3140
					break;
3425
					case 'c':
4806
3141
				case 'h/v':
3426
						value.push( getSlidePastCount() + 1 );
4807
3142
					value.push( indexh + 1 );
3427
						break;
4808
3143
					if( isVerticalSlide() ) value.push( '/', indexv + 1 );
3428
					case 'c/t':
4809
3144
					break;
3429
						value.push( getSlidePastCount() + 1, '/', getTotalSlides() );
4810
3145
				default:
3430
						break;
4811
3146
					value.push( indexh + 1 );
3431
					case 'h/v':
4812
3147
					if( isVerticalSlide() ) value.push( '.', indexv + 1 );
3432
						value.push( indexh + 1 );
4813
3433
						if( isVerticalSlide() ) value.push( '/', indexv + 1 );
4814
3434
						break;
4815
3435
					default:
4816
3436
						value.push( indexh + 1 );
4817
3437
						if( isVerticalSlide() ) value.push( '.', indexv + 1 );
4818
3438
				}
4819
3148
			}
3439
			}
4820
3149
3440
4821
3150
			dom.slideNumber.innerHTML = formatSlideNumber( value[0], value[1], value[2] );
3441
			dom.slideNumber.innerHTML = formatSlideNumber( value[0], value[1], value[2] );
4822
@@ -3428,6 +3719,26 @@
4823
3428
	}
3719
	}
4824
3429
3720
4825
3430
	/**
3721
	/**
4826
3722
	 * Should the given element be preloaded?
4827
3723
	 * Decides based on local element attributes and global config.
4828
3724
	 *
4829
3725
	 * @param {HTMLElement} element
4830
3726
	 */
4831
3727
	function shouldPreload( element ) {
4832
3728
4833
3729
		// Prefer an explicit global preload setting
4834
3730
		var preload = config.preloadIframes;
4835
3731
4836
3732
		// If no global setting is available, fall back on the element's
4837
3733
		// own preload setting
4838
3734
		if( typeof preload !== 'boolean' ) {
4839
3735
			preload = element.hasAttribute( 'data-preload' );
4840
3736
		}
4841
3737
4842
3738
		return preload;
4843
3739
	}
4844
3740
4845
3741
	/**
4846
3431
	 * Called when the given slide is within the configured view
3742
	 * Called when the given slide is within the configured view
4847
3432
	 * distance. Shows the slide element and loads any content
3743
	 * distance. Shows the slide element and loads any content
4848
3433
	 * that is set to load lazily (data-src).
3744
	 * that is set to load lazily (data-src).
4849
@@ -3442,10 +3753,12 @@
4850
3442
		slide.style.display = config.display;
3753
		slide.style.display = config.display;
4851
3443
3754
4852
3444
		// Media elements with data-src attributes
3755
		// Media elements with data-src attributes
4857
3445
		toArray( slide.querySelectorAll( 'img[data-src], video[data-src], audio[data-src]' ) ).forEach( function( element ) {
3756
		toArray( slide.querySelectorAll( 'img[data-src], video[data-src], audio[data-src], iframe[data-src]' ) ).forEach( function( element ) {
4858
3446
			element.setAttribute( 'src', element.getAttribute( 'data-src' ) );
3757
			if( element.tagName !== 'IFRAME' || shouldPreload( element ) ) {
4859
3447
			element.setAttribute( 'data-lazy-loaded', '' );
3758
				element.setAttribute( 'src', element.getAttribute( 'data-src' ) );
4860
3448
			element.removeAttribute( 'data-src' );
3759
				element.setAttribute( 'data-lazy-loaded', '' );
4861
3760
				element.removeAttribute( 'data-src' );
4862
3761
			}
4863
3449
		} );
3762
		} );
4864
3450
3763
4865
3451
		// Media elements with <source> children
3764
		// Media elements with <source> children
4866
@@ -3563,7 +3876,7 @@
4867
3563
		}
3876
		}
4868
3564
3877
4869
3565
		// Reset lazy-loaded media elements with src attributes
3878
		// Reset lazy-loaded media elements with src attributes
4871
3566
		toArray( slide.querySelectorAll( 'video[data-lazy-loaded][src], audio[data-lazy-loaded][src]' ) ).forEach( function( element ) {
3879
		toArray( slide.querySelectorAll( 'video[data-lazy-loaded][src], audio[data-lazy-loaded][src], iframe[data-lazy-loaded][src]' ) ).forEach( function( element ) {
4872
3567
			element.setAttribute( 'data-src', element.getAttribute( 'src' ) );
3880
			element.setAttribute( 'data-src', element.getAttribute( 'src' ) );
4873
3568
			element.removeAttribute( 'src' );
3881
			element.removeAttribute( 'src' );
4874
3569
		} );
3882
		} );
4875
@@ -3663,13 +3976,6 @@
4876
3663
		_appendParamToIframeSource( 'src', 'player.vimeo.com/', 'api=1' );
3976
		_appendParamToIframeSource( 'src', 'player.vimeo.com/', 'api=1' );
4877
3664
		_appendParamToIframeSource( 'data-src', 'player.vimeo.com/', 'api=1' );
3977
		_appendParamToIframeSource( 'data-src', 'player.vimeo.com/', 'api=1' );
4878
3665
3978
4879
3666
		// Always show media controls on mobile devices
4880
3667
		if( isMobileDevice ) {
4881
3668
			toArray( dom.slides.querySelectorAll( 'video, audio' ) ).forEach( function( el ) {
4882
3669
				el.controls = true;
4883
3670
			} );
4884
3671
		}
4885
3672
4886
3673
	}
3979
	}
4887
3674
3980
4888
3675
	/**
3981
	/**
4889
@@ -3713,7 +4019,20 @@
4890
3713
					// Mobile devices never fire a loaded event so instead
4019
					// Mobile devices never fire a loaded event so instead
4891
3714
					// of waiting, we initiate playback
4020
					// of waiting, we initiate playback
4892
3715
					else if( isMobileDevice ) {
4021
					else if( isMobileDevice ) {
4894
3716
						el.play();
4022
						var promise = el.play();
4895
4023
4896
4024
						// If autoplay does not work, ensure that the controls are visible so
4897
4025
						// that the viewer can start the media on their own
4898
4026
						if( promise && typeof promise.catch === 'function' && el.controls === false ) {
4899
4027
							promise.catch( function() {
4900
4028
								el.controls = true;
4901
4029
4902
4030
								// Once the video does start playing, hide the controls again
4903
4031
								el.addEventListener( 'play', function() {
4904
4032
									el.controls = false;
4905
4033
								} );
4906
4034
							} );
4907
4035
						}
4908
3717
					}
4036
					}
4909
3718
					// If the media isn't loaded, wait before playing
4037
					// If the media isn't loaded, wait before playing
4910
3719
					else {
4038
					else {
4911
@@ -3947,7 +4266,7 @@
4912
3947
4266
4913
3948
		}
4267
		}
4914
3949
4268
4916
3950
		return pastCount / ( totalCount - 1 );
4269
		return Math.min( pastCount / ( totalCount - 1 ), 1 );
4917
3951
4270
4918
3952
	}
4271
	}
4919
3953
4272
4920
@@ -3974,9 +4293,9 @@
4921
3974
		var bits = hash.slice( 2 ).split( '/' ),
4293
		var bits = hash.slice( 2 ).split( '/' ),
4922
3975
			name = hash.replace( /#|\//gi, '' );
4294
			name = hash.replace( /#|\//gi, '' );
4923
3976
4295
4927
3977
		// If the first bit is invalid and there is a name we can
4296
		// If the first bit is not fully numeric and there is a name we
4928
3978
		// assume that this is a named link
4297
		// can assume that this is a named link
4929
3979
		if( isNaN( parseInt( bits[0], 10 ) ) && name.length ) {
4298
		if( !/^[0-9]*$/.test( bits[0] ) && name.length ) {
4930
3980
			var element;
4299
			var element;
4931
3981
4300
4932
3982
			// Ensure the named link is a valid HTML ID attribute
4301
			// Ensure the named link is a valid HTML ID attribute
4933
@@ -3988,10 +4307,13 @@
4934
3988
			// Ensure that we're not already on a slide with the same name
4307
			// Ensure that we're not already on a slide with the same name
4935
3989
			var isSameNameAsCurrentSlide = currentSlide ? currentSlide.getAttribute( 'id' ) === name : false;
4308
			var isSameNameAsCurrentSlide = currentSlide ? currentSlide.getAttribute( 'id' ) === name : false;
4936
3990
4309
4941
3991
			if( element && !isSameNameAsCurrentSlide ) {
4310
			if( element ) {
4942
3992
				// Find the position of the named slide and navigate to it
4311
				// If the slide exists and is not the current slide...
4943
3993
				var indices = Reveal.getIndices( element );
4312
				if ( !isSameNameAsCurrentSlide ) {
4944
3994
				slide( indices.h, indices.v );
4313
					// ...find the position of the named slide and navigate to it
4945
4314
					var indices = Reveal.getIndices(element);
4946
4315
					slide(indices.h, indices.v);
4947
4316
				}
4948
3995
			}
4317
			}
4949
3996
			// If the slide doesn't exist, navigate to the current slide
4318
			// If the slide doesn't exist, navigate to the current slide
4950
3997
			else {
4319
			else {
4951
@@ -4029,18 +4351,30 @@
4952
4029
	 */
4351
	 */
4953
4030
	function writeURL( delay ) {
4352
	function writeURL( delay ) {
4954
4031
4353
4965
4032
		if( config.history ) {
4354
		// Make sure there's never more than one timeout running
4966
4033
4355
		clearTimeout( writeURLTimeout );
4967
4034
			// Make sure there's never more than one timeout running
4356
4968
4035
			clearTimeout( writeURLTimeout );
4357
		// If a delay is specified, timeout this call
4969
4036
4358
		if( typeof delay === 'number' ) {
4970
4037
			// If a delay is specified, timeout this call
4359
			writeURLTimeout = setTimeout( writeURL, delay );
4971
4038
			if( typeof delay === 'number' ) {
4360
		}
4972
4039
				writeURLTimeout = setTimeout( writeURL, delay );
4361
		else if( currentSlide ) {
4973
4040
			}
4362
			// If we're configured to push to history OR the history
4974
4041
			else if( currentSlide ) {
4363
			// API is not avaialble.
4975
4364
			if( config.history || !window.history ) {
4976
4042
				window.location.hash = locationHash();
4365
				window.location.hash = locationHash();
4977
4043
			}
4366
			}
4978
4367
			// If we're configured to reflect the current slide in the
4979
4368
			// URL without pushing to history.
4980
4369
			else if( config.hash ) {
4981
4370
				window.history.replaceState( null, null, '#' + locationHash() );
4982
4371
			}
4983
4372
			// If history and hash are both disabled, a hash may still
4984
4373
			// be added to the URL by clicking on a href with a hash
4985
4374
			// target. Counter this by always removing the hash.
4986
4375
			else {
4987
4376
				window.history.replaceState( null, null, window.location.pathname + window.location.search );
4988
4377
			}
4989
4044
		}
4378
		}
4990
4045
4379
4991
4046
	}
4380
	}
4992
@@ -4108,6 +4442,25 @@
4993
4108
	}
4442
	}
4994
4109
4443
4995
4110
	/**
4444
	/**
4996
4445
	 * Returns an array of objects where each object represents the
4997
4446
	 * attributes on its respective slide.
4998
4447
	 */
4999
4448
	function getSlidesAttributes() {
5000
4449
Reviewer	Date Requested	Status
Tomas Groth		Needs Fixing on 2019-06-28
Raoul Snyman	2019-02-12	Needs Fixing on 2019-02-13
Nico Opiyo		Pending
Review via email: mp+363053@code.launchpad.net