Manual.rst 497 KB
Newer Older
1
.. ==================================================
2
.. Header hierarchy
3
4
5
.. ==
..  --
..   ^^
6
..    ""
7
8
9
10
..     ;;
..      ,,
..
.. --------------------------------------------------
11
12
.. Best Practice T3 reST: https://docs.typo3.org/m/typo3/docs-how-to-document/master/en-us/WritingReST/CheatSheet.html
..             Reference: https://docs.typo3.org/m/typo3/docs-how-to-document/master/en-us/WritingReST/Index.html
Carsten  Rose's avatar
Carsten Rose committed
13
.. Italic *italic*are part of key or value
14
15
.. Bold **bold**
.. Code ``text``
16
.. External Links: `Bootstrap <http://getbootstrap.com/>`_
17
.. Add Images:    .. image:: ../images/a4.jpg
18
..
19
20
..
.. Admonitions
21
..       .. note::    .. important::     .. tip::      .. warning::
Carsten  Rose's avatar
Carsten Rose committed
22
.. Color:   (grey)       (orange)           (green)      (red)
23
..
24
25
26
27
.. Definition:
.. some text becomes strong (only one line)
..      description has to indented

28
29
30
31
32
.. -*- coding: utf-8 -*- with BOM.


.. include:: Includes.txt

33
34
35
36
37
.. _general:

General
=======

38
* Project homepage: https://qfq.io
Carsten  Rose's avatar
Carsten Rose committed
39
* Latest releases: https://qfq.io/download
40
* Development: https://git.math.uzh.ch/typo3/qfq
Carsten  Rose's avatar
Carsten Rose committed
41
42
* Chat: https://hello.math.uzh.ch > QFQ

43
44
45
46
47
48

.. _installation:

Installation
============

49
The following features are only tested / supported on linux hosts:
50

51
* General: QFQ is coded to run on Linux hosts, preferable on Debian derivates like Ubuntu.
52
* HTML to PDF conversion - command `wkhtmltopdf`.
53
* Concatenation of PDF files - command `pdfunite`.
54
55
* Mime type detection for uploads - command `file`.

56

57
58
.. _`preparation`:

59
60
61
62
63
64
Preparation
-----------

Report & Form
^^^^^^^^^^^^^

65
To normalize UTF8 input, *php-intl* package is needed by
66
67
68

* normalizer::normalize()

69
For the `download`_ function, the programs `pdfunite` and `file` are necessary to concatenate PDF files.
70

71
Preparation for Ubuntu::
72

73
  sudo apt install php-intl
74
  sudo apt install poppler-utils libxrender1 file pdf2svg  # for file upload, PDF and 'HTML to PDF' (wkhtmltopdf), PDF split
75
  sudo apt install inkscape imagemagick            # to render thumbnails
76

77
.. _wkhtml:
78

79
80
wkhtmltopdf
^^^^^^^^^^^
81

82
83
`wkhtmltopdf <http://wkhtmltopdf.org/>`_ will be used by QFQ to offer 'website print' and 'HTML to PDF' conversion.
The program is not included in QFQ and has to be manually installed.
84

85
86
87
88
* The Ubuntu package `wkhtmltopdf` needs a running Xserver - this does not work on a headless webserver.

  * Best is to install the QT version from the named website above.
  * In case of trouble with wkhtmltopdf, also install 'libxrender1'.
89
90
  * The current version 0.12.4 might have trouble with https connections. Version 0.12.5-dev (github master branch)
    seems more reliable. Please contact the QFQ authors if you need a compiled Ubuntu version of wkhtmltopdf.
91

Carsten  Rose's avatar
Carsten Rose committed
92
In configuration_ specify::
93

Carsten  Rose's avatar
Carsten Rose committed
94
95
    config.cmdWkhtmltopdf:  /opt/wkhtmltox/bin/wkhtmltopdf
    config.baseUrl: http://www.example.com/
96

97
If wkhtml has been compiled with dedicated libraries (not part of LD_LIBRARY_PATH), specify the LD_LIBRARY_PATH together
Carsten  Rose's avatar
Carsten Rose committed
98
with the path-filename::
99

Carsten  Rose's avatar
Carsten Rose committed
100
    config.cmdWkhtmltopdf: LD_LIBRARY_PATH=/opt/wkhtmltox/lib /opt/wkhtmltox/bin/wkhtmltopdf
101

102
103
.. important::

104
    To access FE_GROUP protected pages or content, it's necessary to disable the `[FE][lockIP]` check! `wkhtml`
105
    will access the Typo3 page locally (localhost) and that IP address is different from the client (=user) IP.
106
107

Configure via Typo3 Installtool `All configuration > $TYPO3_CONF_VARS['FE']`: ::
108
109
110

   [FE][lockIP] = 0

111
112
113
114
115
116
.. warning::

    ``[FE][lockIP] = 0`` disables an important anti-'session hijacking' protection. The security level of the whole installation
    will be *lowered*! Again, this is only needed if `wkhtml` needs access to FE_GROUP protected pages & content. As an
    alternative to lower the security level, create a separated page subtree which is only accessible (configured via
    Typoscript) from specific IPs **or** if a FE-User is logged in.
117

118
If there are problems with converting/downloading FE_GROUP protected pages, check configuration_ `showDebugInfo = download` to debug.
119

120
121
122
.. note::

    Converting HTML to PDF gives no error message but RC=-1? Check carefully all includes of CSS, JS, images
123
124
    and so on! Typically some of them fails to load and wkhtml stops running! Verify the correct loading of all elements
    by calling the site via a regular browser and bypassing any browser cache (Ctrl F5).
125

126
127
128
129
130
131
132
133
134
135
136
137
Checklist wkhtml problems
"""""""""""""""""""""""""

* `config.baseUrl` is configured and correct. The baseUrl has to be the same protocol as the website (http or https).
* To track down problems:

  * In configuration_ set `debug.showDebugInfo=auto,download`.
  * Do the download.
  * Check QFQ_LOG_ for any output.
  * Grab the URL given in the QFQ_LOG_, open a browser in private mode (no existing browser session) and open the URL.
  * Check the `--cookie-jar '/tmp/qfq.cookie....'` file for the cookie.
  * Call wkhtml manually on the webserver, with the same options as given in the QFQ_LOG_.
138

139
HTML to PDF conversion
140
""""""""""""""""""""""
141
142
143
144

`wkhtmltopdf` converts a website (local or remote) to a (multi)-page PDF file. It's mainly used in `download`_.

Print
145
"""""
146
147

Different browser prints the same page in different variations. To prevent this, QFQ implements a small PHP wrapper
Carsten  Rose's avatar
Carsten Rose committed
148
`print.php` with uses `wkhtmltopdf` to convert HTML to PDF.
149

150
Provide a `print this page`-link (replace 'current pageId' )::
151

152
  <a href="typo3conf/ext/qfq/Classes/Api/print.php?id={current pageId}">Print this page</a>
153
154
155
156
157

Any parameter specified after `print.php` will be delivered to `wkhtmltopdf` as part of the URL.

Typoscript code to implement a print link on every page::

158
159
  10 = TEXT
  10 {
160
    wrap = <a href="typo3conf/ext/qfq/Classes/Api/print.php?id=|&type=99"><span class="glyphicon glyphicon-print" aria-hidden="true"></span> Printview</a>
161
162
    data = page:uid
  }
163

164
165
166
167
168
169
Send Email
^^^^^^^^^^

QFQ sends mail via `sendEmail` http://caspian.dotconf.net/menu/Software/SendEmail/ - a small perl script without a central
configuration.

170
By default, `sendEmail` uses the local installed MTA, writes a logfile to `fileadmin/protected/log/mail.log` and handles attachments
171
172
173
174
175
via commandline options. A basic HTML email support is implemented.

The latest version is v1.56, which has at least one bug. That one is patched in the QFQ internal version v1.56p1 (see
QFQ GIT sources in directory 'patches/sendEmail.patch').

Carsten  Rose's avatar
Carsten Rose committed
176
Nevertheless, on latest system the TLS support is broken - please check sendEmailProblem_.
177

178
179
180
181
182
The Typo3 sendmail eco-system is not used at all by QFQ.

Thumbnail
^^^^^^^^^

183
Thumbnails will be rendered via ImageMagick (https://www.imagemagick.org/) 'convert' and 'inkscape' (https://inkscape.org).
184
185
'inkscape' is only used for '.svg' files.

186
The Typo3 graphic eco-system is not used at all by QFQ.
187

188
189
Usage: `column-thumbnail`_.

190
191
192
Setup
-----

Carsten  Rose's avatar
Carsten Rose committed
193
* Install the extension via the Extension Manager.
194
195

  * If you install the extension by manual download/upload and get an error message
Carsten  Rose's avatar
Carsten Rose committed
196
    "can't activate extension": rename the downloaded zip file to `qfq.zip` or `qfq_<version>.zip` (e.g. version: 18.12.0).
197

Carsten  Rose's avatar
Carsten Rose committed
198
  * If the Extension Manager stops after importing: check your memory limit in php.ini.
199

Carsten  Rose's avatar
Carsten Rose committed
200
* Copy/rename the file *<site path>/typo3conf/ext/qfq/config.example.qfq.php* to *<site path>/typo3conf/config.qfq.php*.
201
  Configure the necessary settings `configuration`_
Carsten  Rose's avatar
Carsten Rose committed
202
  The configuration file is outside of the extension directory, to not loose it during de-install and install again.
203
* When the QFQ Extension is called the first time on the Typo3 frontend, the file *<ext_dir>/Classes/Sql/formEditor.sql* will
204
  played and fills the database with the *Form editor* records. This also happens automatically after each update of QFQ.
205
206
* Configure Typoscript to include Bootstrap, jQuery, QFQ javascript and CSS files.

207
208
209
210
.. _setup-css-js:

Setup CSS & JS
^^^^^^^^^^^^^^
211
212
::

213
214
215
216
217
218
219
220
221
222
223
224
225
    page.meta {
        X-UA-Compatible = IE=edge
        X-UA-Compatible.attribute = http-equiv
        viewport=width=device-width, initial-scale=1
    }

    page.includeCSS {
        file01 = typo3conf/ext/qfq/Resources/Public/Css/bootstrap.min.css
        file02 = typo3conf/ext/qfq/Resources/Public/Css/bootstrap-theme.min.css
        file03 = typo3conf/ext/qfq/Resources/Public/Css/jqx.base.css
        file04 = typo3conf/ext/qfq/Resources/Public/Css/jqx.bootstrap.css
        file05 = typo3conf/ext/qfq/Resources/Public/Css/qfq-bs.css
        file06 = typo3conf/ext/qfq/Resources/Public/Css/tablesorter-bootstrap.css
226
        file07 = typo3conf/ext/qfq/Resources/Public/Css/font-awesome.min.css
227
228
229
    }

    page.includeJS {
230
231
232
233
234
235
236
        file01 = typo3conf/ext/qfq/Resources/Public/JavaScript/jquery.min.js
        file02 = typo3conf/ext/qfq/Resources/Public/JavaScript/bootstrap.min.js
        file03 = typo3conf/ext/qfq/Resources/Public/JavaScript/validator.min.js
        file04 = typo3conf/ext/qfq/Resources/Public/JavaScript/jqx-all.js
        file05 = typo3conf/ext/qfq/Resources/Public/JavaScript/globalize.js
        file06 = typo3conf/ext/qfq/Resources/Public/JavaScript/tinymce.min.js
        file07 = typo3conf/ext/qfq/Resources/Public/JavaScript/EventEmitter.min.js
Carsten  Rose's avatar
Carsten Rose committed
237
        file08 = typo3conf/ext/qfq/Resources/Public/JavaScript/typeahead.bundle.min.js
238
239
240
241
        file09 = typo3conf/ext/qfq/Resources/Public/JavaScript/qfq.min.js
        file10 = typo3conf/ext/qfq/Resources/Public/JavaScript/jquery.tablesorter.combined.min.js
        file11 = typo3conf/ext/qfq/Resources/Public/JavaScript/jquery.tablesorter.pager.min.js
        file12 = typo3conf/ext/qfq/Resources/Public/JavaScript/widget-columnSelector.min.js
242

243
244
245
        # Only needed in case FormElement 'annotate' is used.
        file20 = typo3conf/ext/qfq/Resources/Public/JavaScript/fabric.min.js
        file21 = typo3conf/ext/qfq/Resources/Public/JavaScript/qfq.fabric.min.js
246
    }
247

248

249
.. _form-editor:
250
251
252

FormEditor
----------
253

254
255
256
Setup a *report* to manage all *forms*:

* Create a Typo3 page.
257
* Set the 'URL Alias' to `form` (recommended) or the individual defined value in parameter `editFormPage` (configuration_).
258
* Insert a content record of type *qfq*.
259
* In the bodytext insert the following code::
260

261
262
    # If there is a form given by SIP: show
    form={{form:SE}}
263

264
    # In case indexQfq != indexData, set dbIndex=indexQfq.
265
    dbIndex = {{indexQfq:Y}}
266

267
268
269
    10 {
        # List of Forms: Do not show this list of forms if there is a form given by SIP.
        # Table header.
Marc Egger's avatar
Marc Egger committed
270
271
        sql = SELECT CONCAT('p:{{pageAlias:T}}&form=form|A:data-reference=newForm') as _pagen, '#', 'Name', 'Title', 'Table', '' FROM (SELECT 1) AS fake WHERE '{{form:SE}}'=''
        head = {{'b|p:id={{pageAlias:T}}&form=copyFormFromExt|t:Copy form from ExtForm|A:data-reference=copyForm' AS _link}}
272
               <table class="table table-hover qfq-table-50 tablesorter tablesorter-filter" id="{{pageAlias:T}}-form">
273
        tail = </table>
Carsten  Rose's avatar
Carsten Rose committed
274
        rbeg = <thead class="sticky"><tr>
275
276
277
        rend = </tr></thead>
        fbeg = <th>
        fend = </th>
278

279
280
        10 {
            # All forms
Marc Egger's avatar
Marc Egger committed
281
            sql = SELECT CONCAT('p:{{pageAlias:T}}&form=form&r=', f.id, '|A:data-reference=editForm', f.name) as _pagee
282
                         , f.id, QMORE(f.name, 50), f.title AS '_striptags', f.tableName
Marc Egger's avatar
Marc Egger committed
283
                         , CONCAT('U:form=form&r=', f.id, '|A:data-reference=deletForm') as _paged
284
285
                      FROM Form AS f
                      ORDER BY f.name
286
287
288
289
290
291
            rbeg = <tr>
            rend = </tr>
            fbeg = <td>
            fend = </td>
        }
    }
292

293
294
295
296
If the QFQ installation becomes bigger and bigger, it me useful to know which form has been used how often, on which
page and when. Find these information included in the `form-editor-usage`_ report.


297
298
.. _install-checklist:

Carsten  Rose's avatar
Carsten Rose committed
299
300
Installation: Check List
------------------------
301

302
303
304
* Protect the directory `<T3 installation>/fileadmin/protected` in Apache against direct file access.

  * `<T3 installation>/fileadmin/protected/` should be used for confidential (uploaded / generated) data.
Carsten  Rose's avatar
Carsten Rose committed
305
  * `<T3 installation>/fileadmin/protected/log/...` is the default place for QFQ log files.
306

307
308
* Protect the directory `<T3 installation>/fileadmin` in Apache to not execute PHP Scripts - malicious uploads won't be executed.
* Setup a log rotation rule for `sqlLog`.
309
310
* Check that `sqlLogMode` is set to `modify` on productive sites. With `none` you have no chance to find out who changed
  which data and `all` really logs a mass of data.
311

312
313
314
315
316
.. _configuration:

Configuration
-------------

317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
.. _config-qfq-php:

config.qfq.php
^^^^^^^^^^^^^^

+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| Keyword                       | Example                                               | Description                                                                |
+===============================+=======================================================+============================================================================+
| DB_<n>_USER                   | DB_1_USER=qfqUser                                     | Credentials configured in MySQL                                            |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| DB_<n>_PASSWORD               | DB_1_PASSWORD=1234567890                              | Credentials configured in MySQL                                            |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| DB_<n>_SERVER                 | DB_1_SERVER=localhost                                 | Hostname of MySQL Server                                                   |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| DB_<n>_NAME                   | DB_1_NAME=qfq_db                                      | Database name                                                              |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
Carsten  Rose's avatar
Carsten Rose committed
333
334
| LDAP_1_RDN                    | LDAP_1_RDN='ou=Admin,ou=example,dc=com'               | Credentials for non-anonymous LDAP access. Only one set supported.         |
| LDAP_1_PASSWORD               | LDAP_1_PASSWORD='mySecurePassword'                    |                                                                            |
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+


Example: *typo3conf/config.qfq.php*: ::

    <?php

    // QFQ configuration
    //
    // Save this file as: <site path>/typo3conf/config.qfq.php

    return [
        'DB_1_USER' => '<DBUSER>',
        'DB_1_SERVER' => '<DBSERVER>',
        'DB_1_PASSWORD' => '<DBPW>',
        'DB_1_NAME' => '<DB>',

Carsten  Rose's avatar
Carsten Rose committed
352
353
354
355
        //DB_2_USER => <DBUSER>
        //DB_2_SERVER => <DBSERVER>
        //DB_2_PASSWORD => <DBPW>
        //DB_2_NAME => <DB>
356
357
358
359

        // DB_n ...
        // ...

Carsten  Rose's avatar
Carsten Rose committed
360
361
        // LDAP_1_RDN => 'ou=Admin,ou=example,dc=com'
        // LDAP_1_PASSWORD => 'mySecurePassword'
362
363
    ];

364
365
366
367
368
.. _extension-manager-qfq-configuration:

Extension Manager: QFQ Configuration
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

369

370
371
372
373
374
375
376
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| Keyword                           | Default / Example                                     | Description                                                                |
+===================================+=======================================================+============================================================================+
| Config                                                                                                                                                                 |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| flagProduction                    | yes                                                   | yes|no: used to differentiate production and development site.             |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
377
378
379
380
381
382
| maxFileSize                       | 10M                                                   | If empty, take minimum of 'post_max_size' and 'upload_max_filesize'.       |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| baseUrl                           | http://example.com                                    | URL where wkhtmltopdf will fetch the HTML (no parameter, those comes later)|
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| dateFormat                        | yyyy-mm-dd                                            | Possible options: yyyy-mm-dd, dd.mm.yyyy.                                  |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
383
384
385
386
387
388
389
390
391
392
393
394
| thumbnailDirSecure                | fileadmin/protected/qfqThumbnail                      | Important: secure directory 'protected' (recursive) against direct access. |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| thumbnailDirPublic                | typo3temp/qfqThumbnail                                | Both thumbnail directories will be created if not existing.                |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| cmdInkscape                       | inkscape                                              | If inkscape is not available, specify an empty string.                     |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| cmdConvert                        | convert                                               | GraphicsMagics 'convert' is recommended.                                   |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| cmdWkhtmltopdf                    | /usr/bin/wkhtmltopdf                                  | PathFilename of wkhtmltopdf. Optional variables like LD_LIBRARY_PATH=...   |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| sendEMailOptions                  | -o tls=yes                                            | General options. Check: http://caspian.dotconf.net/menu/Software/SendEmail |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
395
396
| documentation                     | http://docs.typo3.org...                              | Link to the online documentation of QFQ. Every QFQ installation also       |
|                                   |                                                       | contains a local copy: typo3conf/ext/qfq/Documentation/html/Manual.html    |
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| Dynamic                                                                                                                                                                |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| fillStoreSystemBySql1/2/3         | SELECT s.id AS ...                                    | Specific values read from the database to fill the system store during QFQ |
|                                   |                                                       | load. See `fillStoreSystemBySql`_ for a usecase.                           |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| fillStoreSystemBySqlErrorMsg1/2/3 | No current period found                               | Only define an error message, if QFQ should stop running                   |
|                                   |                                                       | in case of an SQL error or not exact one record.                           |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| Debug                                                                                                                                                                  |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| throwExceptionGeneralError        | auto                                                  | | *yes*: 'general errors' in QFQ (PHP) will throw an exception.            |
|                                   |                                                       | | *auto*: becomes 'yes', if 'flagProduction'!='yes', else 'no'.            |
|                                   |                                                       | | *no*: 'general errors' in QFQ (PHP) will be silently ignored.            |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| formSubmitLogMode                 | all                                                   | | *all*: every form submission will be logged.                             |
|                                   |                                                       | | *none*: no logging.                                                      |
414
|                                   |                                                       | | See `form-submit-log-page`_ for example QFQ code to display the log.     |
415
416
417
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| redirectAllMailTo                 | john@doe.com                                          | If set, redirect all QFQ generated mails (Form, Report) to the specified.  |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
418
419
420
421
| sqlLogMode                        | modify                                                | | *all*: every statement will be logged - this might be a lot.             |
|                                   |                                                       | | *modifyAll*: log all statements which might change data, even if 0 rows  |
|                                   |                                                       | |    affected.                                                             |
|                                   |                                                       | | *modify*: log only statements which change data (affected rows > 0).     |
422
|                                   |                                                       | | *error*: log only DB errors.                                             |
423
424
|                                   |                                                       | | *none*: no SQL log at all.                                               |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
425
426
| sqlLogModeAutoCron                | error                                                 | Applies only to AutoCron Jobs. For production 'error' should be fine.      |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
| sqlLog                            | fileadmin/protected/log/sql.log                       | Filename to log SQL commands: relative to <site path> or absolute. If the  |
|                                   |                                                       | directory does not exist, create it.                                       |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| qfqLog                            | fileadmin/protected/log/qfq.log                       | Filename to log general QFQ events:relative to <site path> or absolute.    |
|                                   |                                                       | If the directory does not exist, create it.                                |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| mailLog                           | fileadmin/protected/log/mail.log                      | Filename to log `sendEmail` commands: relative to <site path> or absolute. |
|                                   |                                                       | If the directory does not exist, create it.                                |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| showDebugInfo                     | auto                                                  | FE - Possible values: yes|no|auto|download. For 'auto': If a BE User is    |
|                                   |                                                       | logged in, a debug information will be shown on the FE.                    |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| Database                                                                                                                                                               |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| init                              | init=SET names utf8; SET sql_mode =                   | Global init for using the database. For 'sql_mode="NO_ENGINE_SUBSTITUTION"'|
|                                   | "NO_ENGINE_SUBSTITUTION"                              | see #7407.                                                                 |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| update                            | auto                                                  | | *auto*: apply DB Updates only if there is a newer version.               |
|                                   |                                                       | | *always*: apply DB Updates always, especially play formEditor.sql every  |
|                                   |                                                       |   time QFQ is called - *not* recommended!                                  |
|                                   |                                                       | | *never*: never apply DB Updates.                                         |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| indexData                         | 1                                                     | Optional. Default: 1. Retrieve the current setting via {{dbNameData:Y}}.   |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| indexQfq                          | 1                                                     | Optional. Default: 1. Retrieve the current setting via {{dbNameQfq:Y}}.    |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| Security                                                                                                                                                               |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| escapeTypeDefault                 | m                                                     | All variables `{{...}}` get this escape class by default.                  |
|                                   |                                                       | See `variable-escape`_.                                                    |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| securityVarsHoneypot              | email,username,password                               | If empty: no check. All named variables will rendered as INPUT elements.   |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| securityAttackDelay               | 5                                                     | If an attack is detected, sleep 'x' seconds and exit PHP process.          |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| securityShowMessage               | true                                                  | If an attack is detected, show a message.                                  |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| securityGetMaxLength              | 50                                                    | GET vars longer than 'x' chars triggers an `attack-recognized`.            |
|                                   |                                                       | `ExceptionMaxLength`_.                                                     |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
467
| securityFailedAuthDelay           | 3                                                     | If REST authorization fails, sleep 'x' seconds before answering.           |
468
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
| Form-Config                                                                                                                                                            |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| recordLockTimeoutSeconds          | 900                                                   | Timeout for record locking. After this time, a record will be replaced.    |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| sessionTimeoutSeconds             | 1800                                                  | Timeout for FE User session. See sessionTimeoutSeconds_                    |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| enterAsSubmit                     | enterAsSubmit = 1                                     | 0: off, 1: Pressing *enter* in a form means *save* and *close*.            |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| editFormPage                      | form                                                  | T3 Pagealias to edit a form.                                               |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| formDataPatternError              | please check pattern error                            | Customizable error message used in validator.js. 'pattern' violation.      |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| formDataRequiredError             | missing value                                         | Customizable error message used in validator.js. 'required' fields.        |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| formDataMatchError                | type error                                            | Customizable error message used in validator.js. 'match' retype mismatch.  |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| formDataError                     | generic error                                         | Customizable error message used in validator.js. 'no specific' given.      |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| Form-Layout                                                                                                                                                            |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| labelAlign                        | left                                                  | Label align (left/center/right)/ Default: left. Will be inherited to Form. |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| cssClassQfqContainer              | container                                             | | QFQ with own Bootstrap: 'container'.                                     |
|                                   |                                                       | | QFQ already nested in Bootstrap of mainpage: <empty>.                    |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| cssClassQfqForm                   | qfq-color-base                                        | Wrap around QFQ 'Form'.                                                    |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| cssClassQfqFormPill               | qfq-color-grey-1                                      | Wrap around title bar for pills: CSS Class, typically a background color.  |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| cssClassQfqFormBody               | qfq-color-grey-2                                      | Wrap around FormElements: CSS Class, typically a background color.         |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| formBsColumns                     | col-md-12 col-lg-10                                   | The whole form will be wrapped. See `bs-custom-field-width`_               |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| formBsLabelColumns                | col-md-3 col-lg-3                                     | The column get the width. See `bs-custom-field-width`_                     |
+-----------------------------------+-------------------------------------------------------+                                                                            |
| formBsInputColumns                | col-md-6 col-lg-6                                     |                                                                            |
+-----------------------------------+-------------------------------------------------------+                                                                            |
| formBsNoteColumns                 | col-md-3 col-lg-3                                     |                                                                            |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| extraButtonInfoInline             | <img src="info.png">                                  | Image for `extraButtonInfo`_ (inline).                                     |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| extraButtonInfoBelow              | <img src="info.png">                                  | Image for `extraButtonInfo`_ (below).                                      |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| extraButtonInfoPosition           | below                                                 | 'auto' (default) or 'below'. See `extraButtonInfo`_.                       |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| extraButtonInfoClass              | pull-right                                            | '' (default) or 'pull-right'. See `extraButtonInfo`_.                      |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| Form-Language                                                                                                                                                          |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
Carsten  Rose's avatar
Carsten Rose committed
518
| formLanguage[ABCD]Id              | E.g.: 1                                               | In Typo3 configured pageLanguage id. The number after the 'L' parameter.   |
519
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
Carsten  Rose's avatar
Carsten Rose committed
520
| formLanguage[ABCD]Label           | E.G.: english                                         | Label shown in *Form editor*, on the 'basic' tab.                          |
521
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
Carsten  Rose's avatar
Carsten Rose committed
522
| saveButtonText                    |                                                       | Text on the form save button. Typically none.                              |
523
524
525
526
527
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| saveButtonTooltip                 | Save                                                  | Tooltip on the form save button.                                           |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| saveButtonClass                   | btn btn-default navbar-btn                            | Bootstrap CSS class for save button on top of the form.                    |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
528
| buttonOnChangeClass               | alert-info btn-info                                   | Bootstrap CSS class for save button showing 'data changed'.                |
529
530
531
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| saveButtonGlyphIcon               | glyphicon-ok                                          | Icon for the form save button.                                             |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
Carsten  Rose's avatar
Carsten Rose committed
532
| closeButtonText                   |                                                       | Text on the form close button. Typically none.                             |
533
534
535
536
537
538
539
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| closeButtonTooltip                | close                                                 | Tooltip on the form close button.                                          |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| closeButtonClass                  | btn btn-default navbar-btn                            | Bootstrap CSS class for close button on top of the form.                   |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| closeButtonGlyphIcon              | glyphicon-remove                                      | Icon for the form close button.                                            |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
Carsten  Rose's avatar
Carsten Rose committed
540
| deleteButtonText                  |                                                       | Text on the form delete button. Typically none.                            |
541
542
543
544
545
546
547
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| deleteButtonTooltip               | delete                                                | Tooltip on the form delete button.                                         |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| deleteButtonClass                 | btn btn-default navbar-btn                            | Bootstrap CSS class for delete button on top of the form.                  |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| deleteButtonGlyphIcon             | glyphicon-trash                                       | Icon for the form delete button.                                           |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
Carsten  Rose's avatar
Carsten Rose committed
548
| newButtonText                     |                                                       | Text on the form new button. Typically none.                               |
549
550
551
552
553
554
555
556
557
558
559
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| newButtonTooltip                  | new                                                   | Tooltip on the form new button.                                            |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| newButtonClass                    | btn btn-default navbar-btn                            | Bootstrap CSS class for new button on top of the form.                     |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| newButtonGlyphIcon                | glyphicon-plus                                        | Icon for the form new button.                                              |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| showIdInFormTitle                 | 0 (off), 1 (on)                                       | Append at the form title the current record id.                            |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| cssClassColumnId                  | text-muted                                            | A column in a subrecord with the name id|ID|Id gets this class.            |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
560

561
After parsing the configuration, the following variables will be set automatically in STORE_SYSTEM:
562
563
564
565

+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| Keyword                       | Description                                                                                                                        |
+===============================+====================================================================================================================================+
566
| dbNameData                    | Name of the 'data'-database. '{{dbNameData:Y}}                                                                                     |
567
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
568
| dbNameQfq                     | Name of the 'QFQ'-database. '{{dbNameQfq:Y}}                                                                                       |
569
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
570
571
| dbNameT3                      | Name of the 'T3'-database. '{{dbNameT3:Y}}                                                                                         |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
572
| sitePath                      | Absolute path of the current T3 instance. '{{sitePath:Y}}                                                                          |
573
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
574
| extPath                       | Absolute path of the QFQ extension. '{{extPath:Y}}                                                                                 |
575
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
576

577

578
579
580
581
.. _`CustomVariables`:

Custom variables
^^^^^^^^^^^^^^^^
582

583
Up to 30 custom variables can be defined in `configuration`_.
584

585
E.g. to setup a contact address and reuse the information inside your installation do: ::
586

587
588
589
   custom1: ADMINISTRATIVE_CONTACT = john@doe.com
   custom2: ADMINISTRATIVE_ADDRESS = John Doe, Hollywood Blvd. 1, L.A.
   custom3: ADMINISTRATIVE_NAME = John Doe
590
591
592
593
594

 * Somewhere in a `Form` or in `Report`::

      {{ADMINISTRATIVE_CONTACT:Y}}, {{ADMINISTRATIVE_ADDRESS:Y}}, {{ADMINISTRATIVE_NAME}}

595
596
It's also possible to configure such variables directly in `config.qfq.php`_.

Carsten  Rose's avatar
Carsten Rose committed
597
.. _`fillStoreSystemBySql`:
598

Carsten  Rose's avatar
Carsten Rose committed
599
600
Fill STORE_SYSTEM by SQL
^^^^^^^^^^^^^^^^^^^^^^^^
601

602
603
A specified SELECT statement in `configuration`_ in variable `fillStoreSystemBySql1` (or `2`,
or `3`) will be fired. The query should have 0 (nothing happens) or 1 row. All columns will be
Carsten  Rose's avatar
Carsten Rose committed
604
**added** to the existing STORE_SYSTEM. Existing variables will be overwritten. Be careful not to overwrite system values.
605

Carsten  Rose's avatar
Carsten Rose committed
606
607
608
609
610
611
This option is useful to make generic custom values, saved in the database, accessible to all QFQ Report and Forms.
Access such variables via `{{<varname>:Y}}`.

In case QFQ should stop working if a given query does not select exact one record (e.g. a missing period), define an
error message: ::

612
613
  fillStoreSystemBySql1: SELECT name FROM Person WHERE name='Doe'
  fillStoreSystemBySqlErrorMsg1: Too many or to few "Doe's" in our database
614

615
.. _`periodId`:
616
617

periodId
618
""""""""
619
620
621

This is

Carsten  Rose's avatar
Carsten Rose committed
622
* a usecase, implemented via `fillStoreSystemBySql`_,
623
* a way to access `Period.id` with respect to the current period (the period itself is custom defined).
624

625
After a full QFQ installation:
626
627
628
629

* a table `Period` (extend / change it to your needs, fill them with your periods),
* one sample record in table `Period`,

630
Websites, delivering semester data, school year schedules, or any other type or periods, often need an index to the
Carsten  Rose's avatar
Carsten Rose committed
631
*current* period.
632

633
In configuration_: ::
634

635
  fillStoreSystemBySql1: SELECT id AS periodId FROM Period WHERE start<=NOW() ORDER BY start DESC LIMIT 1
636
637
638
639
640
641
642
643

a variable 'periodId' will automatically computed and filled in STORE SYSTEM. Access it via `{{periodId:Y0}}`.
To get the name and current period: ::

  SELECT name, ' / ', start FROM Period WHERE id={{periodId:Y0}}

Typically, it's necessary to offer a 'previous' / 'next' link. In this example, the STORE SIP holds the new periodId: ::

644
645
  SELECT CONCAT('p:{{pageAlias:T}}&periodId=', {{periodId:SY0}}-1, '|Next') AS _page, ' ', name, ' ',
    CONCAT('p:{{pageAlias:T}}&periodId=', {{periodId:SY0}}+1, '|Next') AS _page FROM Period AS s WHERE s.id={{periodId:SY0}}
646
647
648
649

Take care for minimum and maximum indexes (do not render the links if out of range).

.. _`DbUserPrivileges`:
650
651
652
653
654
655
656
657

DB USER privileges
^^^^^^^^^^^^^^^^^^

The specified DB User needs privileges to the database of at least: SELECT / INSERT / UPDATE / DELETE / SHOW.

To apply automatically QFQ-'DB UPDATE' the following rights are mandatory too: CREATE / ALTER

658
To get access to the Typo3 installation, 'dbuser' should also have access to the Typo3 Database with at least SELECT / INSERT / UPDATE / DELETE.
659
660
661



662
663
664
665
666
.. _`ExceptionMaxLength`:

Exception for SECURITY_GET_MAX_LENGTH
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

667
If it is necessary to use a GET variable which exceeds `securityGetMaxLength` limit, name the variable with '_<num>' at
668
the end. E.g. `my_long_variable_130`. Such a variable has an allowed length of 130 chars. Access the variable as
669
670
671
usual with the variable name: `{{my_long_variable_130:C:...}}`.


672
673
674
675
676
677
678
.. _`sessionTimeoutSeconds`:

FE-User: Session timeout seconds
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

There is no timeout for website users who are not logged in (but typically those users don't have access to protected content).

679
680
For logged in users, the default timeout is the php.ini settings for `session.cookie_lifetime` and `session.gc_maxlifetime`
(minimum of both). These timeout only affects QFQ related content and can be
681
682
683
684
685
686
687
688
689
specified a) globally (QFQ configuration) and b) specific per Form.

The maximum timeout depends on the minimal value of php.ini `session.cookie_lifetime` and `session.gc_maxlifetime`.
Specifying a higher value produces an error in the front end.

Every access to QFQ related content resets the timeout.

After FE login, the next access to QFQ related content starts the timeout counter.

690
691
692
693
694
.. _local-documentation:

Local Documentation
-------------------

695
A HTML rendered version is available under: <your site>/typo3conf/ext/qfq/Documentation/html/Index.html
696

697
698
If you get a 'Page forbidden / not found' there might be some Webserver restrictions. E.g. the Typo3 example of `.htaccess`
in the Typo3 installation folder will forbid access to any extension documentation (which is a good idea on a productive
699
700
server). For a development server instead, deactivate the forbid rule of 'documentation'. In `.htaccess` (snippet from
Typo3 7.6 _.htaccess): ::
701

702
703
  production:   RewriteRule (?:typo3conf/ext|typo3/sysext|typo3/ext)/[^/]+/(?:Configuration|Resources/Private|Tests?|Documentation|docs?)/ - [F]
  development:  RewriteRule (?:typo3conf/ext|typo3/sysext|typo3/ext)/[^/]+/(?:Configuration|Resources/Private|Tests?|docs?)/ - [F]
704
705
706
707
708
709

.. _concept:

Concept
=======

710
711
712
713
714
SIPs
----

The following is a technical background information. Not needed to just use QFQ.

715
The SIPs (=Server Id Pairs) are uniq timestamps, created/registered on the fly for a specific browser session (=user). Every SIP is
716
registered on the server (= stored in a browser session) and contains one or more key/value pairs. The key/value pairs never leave
717
718
719
720
721
722
723
724
725
726
727
728
729
the server. The SIPs will be used:

* to protect values not to be spoofed by anyone,
* to protect values not to be altered by anyone,
* to grant access, e.g.:

  * load and save forms,
  * upload files,
  * download files,
  * PHP AJAX pages.

SIPs becomes invalid, as soon as the current browser session is destroyed. The client (= user) can't manipulate the content
of SIPs - it's only possible to reuse already registered SIPs by the user, who already owns the session.
730
731
732
733
734

Access privileges
-----------------

The Typo3 FE Groups can be used to implement access privileges. Such groups are assigned to
735

736
737
738
739
740
741
742
* Typo3 FE users,
* Typo3 pages,
* and/or Typo3 content records (e.g. QFQ records).

This will be used for general page structure privileges.

A `record base` privileges controlling (e.g. which user can edit
743
744
which person record) will be implicit configured, by the way that records are viewable / editable (or not) through
SQL in the specific QFQ tt-content statements.
745
746
747
748
749
750

Typo3 QFQ content element
-------------------------

Insert one or more QFQ content elements on a Typo3 page. Specify column and language per content record as wished.

751
752
The title of the QFQ content element will not be rendered on the frontend. It's only visible to the webmaster in the
backend for orientation.
753

Nicola Chiapolini's avatar
Nicola Chiapolini committed
754
755
.. _qfq_keywords:

756
757
758
QFQ Keywords (Bodytext)
^^^^^^^^^^^^^^^^^^^^^^^

759
760
**All of the named parameter are optional.**

761
762
763
 +-------------------+---------------------------------------------------------------------------------+
 | Name              | Explanation                                                                     |
 +===================+=================================================================================+
764
765
766
767
768
769
770
771
772
 | form              | | Formname.                                                                     |
 |                   | | Static: **form = person**                                                     |
 |                   | | By SIP: **form = {{form:SE}}**                                                |
 |                   | | By SQL: **form = {{SELECT c.form FROM config AS c WHERE c.id={{a:C}} }}**     |
 +-------------------+---------------------------------------------------------------------------------+
 | r                 | | <record id>. The form will load the record with the specified id.             |
 |                   | | Static: **r = 123**                                                           |
 |                   | | By SQL: **r = {{SELECT ...}}**                                                |
 |                   | | If not specified, the SIP parameter 'r' is used.                              |
773
 +-------------------+---------------------------------------------------------------------------------+
774
775
776
777
 | dbIndex           | E.g. `dbIndex = {{indexQfq:Y}}` Select a DB index. Only necessary if a          |
 |                   | different than the standard DB should be used.                                  |
 +-------------------+---------------------------------------------------------------------------------+
 | debugShowBodyText | If='1' and configuration_:*showDebugInfo: yes*, shows a tooltip with bodytext   |
778
 +-------------------+---------------------------------------------------------------------------------+
779
780
781
 | sqlLog            | Overwrites configuration_: `SQL_LOG`_ . Only affects `Report`, not `Form`.      |
 +-------------------+---------------------------------------------------------------------------------+
 | sqlLogMode        | Overwrites configuration_: `SQL_LOG_MODE`_ . Only affects `Report`, not `Form`. |
782
783
784
785
786
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.fbeg      | Start token for every field (=column)                                           |
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.fend      | End token for every field (=column)                                             |
 +-------------------+---------------------------------------------------------------------------------+
Carsten  Rose's avatar
Carsten Rose committed
787
788
789
790
 | <level>.fsep      | Separator token between fields (=columns)                                       |
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.fskipwrap | Comma separated list of column id's. Skip wrapping of indexed columns.          |
 +-------------------+---------------------------------------------------------------------------------+
791
 | <level>.shead     | Static start token for whole <level>, independent if records are selected       |
792
 |                   | Shown before `head`.                                                            |
793
 +-------------------+---------------------------------------------------------------------------------+
794
 | <level>.stail     | Static end token for whole <level>, independent if records are selected.        |
795
 |                   | Shown after `tail`.                                                             |
796
797
798
799
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.head      | Dynamic start token for whole <level>. Only if at least one record is select.   |
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.tail      | Dynamic end token for whole <level>. Only if at least one record is select.     |
800
801
802
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.rbeg      | Start token for row.                                                            |
 +-------------------+---------------------------------------------------------------------------------+
803
 | <level>.rbgd      | Alternating (per row) token.                                                    |
804
805
806
807
808
809
810
811
812
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.rend      | End token for row. Will be rendered **before** subsequent levels are processed  |
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.renr      | End token for row. Will be rendered **after** subsequent levels are processed   |
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.rsep      | Seperator token between rows                                                    |
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.sql       | SQL Query                                                                       |
 +-------------------+---------------------------------------------------------------------------------+
Nicola Chiapolini's avatar
Nicola Chiapolini committed
813
814
 | <level>.twig      | Twig Template                                                                   |
 +-------------------+---------------------------------------------------------------------------------+
815
 | <level>.althead   | If <level>.sql has no rows selected (empty), these token will be rendered.      |
816
 +-------------------+---------------------------------------------------------------------------------+
817
818
819
 | <level>.altsql    | If <level>.sql has no rows selected (empty) or affected (delete, update, insert)|
 |                   | the <altsql> will be fired. Note: Sub queries of <level> are not fired, even if |
 |                   | <altsql> selects some rows.                                                     |
820
 +-------------------+---------------------------------------------------------------------------------+
821
822
 | <level>.content   | | *show* (default): content of current and sub level are directly shown.        |
 |                   | | *hide*: content of current and sub levels are stored and not shown.           |
Nicola Chiapolini's avatar
Nicola Chiapolini committed
823
824
 |                   | | *hideLevel*: content of current and sub levels are stored and only sub levels |
 |                   | | are shown.                                                                    |
825
826
 |                   | | *store*: content of current and sub levels are stored and shown.              |
 |                   | | To retrieve the content: `{{<level>.line.content}}`. See `syntax-of-report`_  |
827
 +-------------------+---------------------------------------------------------------------------------+
828

829
830
831
832
833
834
835
836
.. _`qfq-database`:

QFQ Database
------------

Recommended setup for Typo3 & QFQ Installation is with *two* databases. One for the Typo3 installation and one for QFQ.
A good practice is to name both databases equal, appending the suffix '_t3' and '_db'.

Carsten  Rose's avatar
Carsten Rose committed
837
When QFQ is called, it checks for QFQ system tables. If they do not exist or have a lower version than the installed QFQ
838
839
840
841
842
843
844
version, the system tables will be automatically installed or updated.

.. _`system-tables`:

System tables
^^^^^^^^^^^^^

845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
+---------------+------------+------------+
| Name          | Use        | Database   |
+===============+============+============+
| Clipboard     | Temporary  | QFQ        |
+---------------+------------+------------+
| Cron          | Persistent | QFQ        |
+---------------+------------+------------+
| Dirty         | Temporary  | QFQ | Data |
+---------------+------------+------------+
| Form          | Persistent | QFQ        |
+---------------+------------+------------+
| FormElement   | Persistent | QFQ        |
+---------------+------------+------------+
| FormSubmitLog | Persistent | QFQ | Data |
+---------------+------------+------------+
| MailLog       | Persistent | QFQ | Data |
+---------------+------------+------------+
| Period        | Persistent | Data       |
+---------------+------------+------------+
| Split         | Persistent | Data       |
+---------------+------------+------------+

867
See `mail-log-page`_ and `form-submit-log-page`_ for some Frontend views for these tables.
868

Carsten  Rose's avatar
Carsten Rose committed
869
* Check Bug #5459 / support of system tables in different DBs not supported.
870

871
872
873
874
.. _`multi-database`:

Multi Database
^^^^^^^^^^^^^^
875

876
Base: T3 & QFQ
877
""""""""""""""
878

879
880
QFQ typically interacts with one database, the QFQ database. The database used by Typo3 is typically a separate one.
Theoretically it might be the same (never tested), but it's strongly recommended to use a separated QFQ database to have
Carsten  Rose's avatar
Carsten Rose committed
881
no problems on Typo3 updates and to have a clean separation between Typo3 and QFQ.
882
883

QFQ: System & Data
884
""""""""""""""""""
885

Carsten  Rose's avatar
Carsten Rose committed
886
887
QFQ itself can be separated in 'QFQ system' (see `system-tables`_) and 'QFQ data' databases (even more than one are
possible). The 'QFQ system' stores the forms, record locking, log tables and so on - `QFQ data` is for the rest.
888
889
890
891

A `Multi Database` setup is given, if 'QFQ system' is different from 'QFQ data'.

Data: Data1, Data2, ..., Data n
892
"""""""""""""""""""""""""""""""
893

894
Every database needs to be configured via `configuration`_ with it's own `index`.
895

896
897
898
`QFQ data` might switch between different 'data'-databases. In configuration_ one main `QFQ data` index will be specified
in `indexQfq`. If specific forms or reports should use a different database than that, `dbIndex` might change
`indexData` temporarily.
899
900

`dbIndex`: A `Report` (field `dbIndex`) as well as a `Form` (field `parameter`.`dbIndex`) can operate on a specific database.
901

902
903
904

A `Form` will:

Carsten  Rose's avatar
Carsten Rose committed
905
* load the form-definition from `indexQfq` (table `Form` and `FormElement`),
906
* loads and save data from/in `indexData` (config.qfq.php) / `dbIndex` (form.parameter.dbIndex),
907
* retrieve extra information via `dbIndexExtra` - this is useful to offer information from a database and save them in a
908
  different one.
909

910
911
The simplest setup, QFQ system & data in the same database, needs no `indexQfq / indexData` definition in
configuration_ or one or both of them set to '1'
912

913
To separate QFQ system and data, indexQfq and indexData will have different indexes.
914
915
916
917
918
919
920


A Multi Database setup might be useful for:

* several independent Typo3 QFQ installations (each have it's own form repository) and one central database, or
* one QFQ installation which should display / load /save records from different databases, or
* a combination of the above two.
921

922
Note:
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944

* Option 'A' is the most simple and commonly used.
* Option 'B' separate the T3 and QFQ databases on two database hosts.
* Option 'C' is like 'B' but with a shared 'QFQ data'-database between three 'Typo3 / QFQ' instances.
* Further variants are possible.

+---+----------------+--------------+-------------------------------+------------------------------+----------------------------------+
|   | Domain         | Website Host | T3                            | QFQ system                   | QFQ data                         |
+===+================+==============+===============================+==============================+==================================+
| A | standalone.edu | 'w'          | <dbHost>, <dbname>_t3, <dbnameSingle>_db                                                        |
+---+----------------+--------------+-------------------------------+------------------------------+----------------------------------+
| B | appB1.edu      | 'wApp'       | <dbHostApp>, <dbnameB1>_t3    | <dbHostB1>, <dbnameApp>_db                                      |
+---+----------------+--------------+-------------------------------+------------------------------+----------------------------------+
| B | appB2.edu      | 'wApp'       | <dbHostApp>, <dbnameB2>_t3    | <dbHostB2>, <dbnameApp>_db                                      |
+---+----------------+--------------+-------------------------------+------------------------------+----------------------------------+
| C | appC1.edu      | 'wAppC'      | <dbHostAppC>, <dbnameC1>_t3   | <dbHostC>, <dbnameSysC1>_db  | <dbHostData>_db, <dbNameData>_db |
+---+----------------+--------------+-------------------------------+------------------------------+----------------------------------+
| C | appC2.edu      | 'wAppC'      | <dbHostAppC>, <dbnameC2>_t3   | <dbHostC>, <dbnameSysC2>_db  | <dbHostData>_db, <dbNameData>_db |
+---+----------------+--------------+-------------------------------+------------------------------+----------------------------------+
| C | appC3.edu      | 'wAppC3'     | <dbHostAppC3>, <dbnameC3>_t3  | <dbHostC3>, <dbnameSysC3>_db | <dbHostData>_db, <dbNameData>_db |
+---+----------------+--------------+-------------------------------+------------------------------+----------------------------------+

945
In config-qfq-php_ mutliple database credentials can be prepared. Mandatory is at least one credential setup like
946
947
948
`DB_1_USER`, `DB_1_SERVER`, `DB_1_PASSWORD`, `DB_1_NAME`. The number '1' indicates the `dbIndex`. Increment the number
to specify further database credential setups.

949
Typically the credentials for `DB_1`  also have access to the T3 database.
950
951
952
953
954
955


Different QFQ versions, shared database
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

When using different QFQ versions and a shared 'QFQ data'-database, there is some risk of conflicting
Carsten  Rose's avatar
Carsten Rose committed
956
'QFQ system' tables. Best is to always use the same QFQ version on all instances or use a Multi Database setup.
957

958
959
960
.. _debug:

Debug
961
962
=====

963
964
965
966
.. _QFQ_LOG:

QFQ Log
-------
967

968
Setup in configuration_
969

970
971
972
973
974
975
976
977
* *qfqLog*

  * Filename where to log QFQ debug and error messages.
  * File is relative to the `<site path>` or absolute (starting with '/').
  * Content: error situations of QFQ and debug, if enabled.

All non SQL related information will be logged to QFQ log file.

978
979
.. _SQL_LOG:

980
981
982
983
984
SQL Log
-------

Setup in configuration_

985
* *sqlLog*
986
987

  * Filename where to log SQL queries and statistical data.
988
  * File is relative to the `<site path>` or absolute (starting with '/').
989
990
991
  * Content: SQL queries and timestamp, formName/formId, fe_user, success, affected rows, newly created record
    id's and accessed from IP.
  * The global setting can be overwritten by defining `sqlLog` inside of a QFQ tt-content record.
992

993
994
995

.. _SQL_LOG_MODE:

996
* *sqlLogMode: all|modify|error|none*
997
998
999
1000
1001
1002
1003

  * *all*: logs every SQL statement.
  * *modify*: logs only statements who might potentially change data.
  * *error*: logs only queries which generate SQL errors.
  * *none*: no query logging at all.
  * The global setting can be overwritten by defining `sqlLogMode` inside of a QFQ tt-content record.

1004
* *showDebugInfo = [yes|no|auto],[download]*
1005
1006

  If active, displays additional information in the Frontend (FE). This is typically helpful during development.
1007
1008
1009
1010
1011
1012

  * *yes*:

    * Form:

      * For every internal link/button, show tooltips with decoded SIP on mouseover.
1013
      * Shows an 'Edit form'-button (wrench symbol) on a form. The link points to the T3 page with the :ref:`form-editor`.
1014
1015
1016
1017
1018
1019
1020
1021
1022

    * Report: Will be configured per tt-content record.

      *debugShowBodyText = 1*

  * *no*: No debug info.

  * *auto*: Depending if there is a Typo3 BE session, set internally:

1023
1024
    * *showDebugInfo = yes*  (BE session exist)
    * *showDebugInfo = no*   (no BE session)
1025

1026
1027
1028
  * *download*:

    * During a download (especially by using wkhtml), temporary files are not deleted automatically. Also the
1029
      ``wkhtmltopdf`` and ``pdfunite`` command lines will be logged to `QFQ_LOG`_. Use this only to debug problems on download.
1030

1031
.. _MAIL_LOG:
1032

1033
1034
MAIL Log
--------
1035

1036
Setup in configuration_
1037

1038
* *mailLog*
1039

1040
1041
  * File which `sendEmail` logs sending mail.
  * File is relative to the `<site path>` or absolute (starting with '/').
1042

1043

Carsten  Rose's avatar
Carsten Rose committed
1044
.. _`mail-log-page`:
1045

1046
1047
Mail Log page (Table MailLog)
-----------------------------
1048
1049

For debugging purposes you may like to add a Mail Log page in the frontend.
1050
The following QFQ code could be used for that purpose (put it in a QFQ PageContent element)::
1051
1052
1053
1054
1055
1056
1057

    # Page parameters
    1.sql = SELECT @grId := '{{grId:C0:digit}}' AS _grId
    2.sql = SELECT @summary := IF('{{summary:CE:alnumx}}' = 'true', 'true', 'false') AS _s

    # Filters
    10 {
Carsten  Rose's avatar
Carsten Rose committed
1058
      sql = SELECT "'", gr.id, IF(gr.id = @grId, "' selected>", "'>"), gr.value, ' (Id: ', gr.id, ')'
1059
1060
1061
               FROM gGroup AS gr
               INNER JOIN MailLog AS ml ON ml.grId = gr.id
               GROUP BY gr.id
1062
1063
      head = <form onchange='this.submit();' class='form-inline'><input type='hidden' name='id' value='{{pageAlias:T0}}'>
               Filter By Group: <select name='grId' class='form-control'><option value=''></option>
Carsten  Rose's avatar
Carsten Rose committed
1064
      rbeg = <option value=
1065
1066
1067
      rend = </option>
      tail = </select>
    }
1068

1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
    20 {
      sql = SELECT IF(@summary = 'true', ' checked', '')
      head = <div class='checkbox'><label><input type='checkbox' name='summary' value='true'
      tail = >Summary</label></div></form>
    }

    # Mail Log
    50 {
      sql = SELECT id, '</td><td>', grId, '</td><td>', xId, '</td><td>',
                REPLACE(receiver, ',', '<br>'), '</td><td>', REPLACE(sender, ',', '<br>'), '</td><td>',
                DATE_FORMAT(modified, '%d.%m.%Y<br>%H:%i:%s'), '</td><td style="word-break:break-word;">',
1080
1081
1082
                CONCAT('<b>', subject, '</b><br>', IF(@summary = 'true', CONCAT(SUBSTR(body, 1,
                       LEAST(IF(INSTR(body, '\n') = 0, 50, INSTR(body, '\n')), IF(INSTR(body, '<br>') = 0, 50,
                       INSTR(body, '<br>')))-1), ' ...'), CONCAT('<br>', REPLACE(body, '\n', '<br>'))) )
1083
1084
1085
              FROM MailLog WHERE (grId = @grId OR @grId = 0)
              ORDER BY modified DESC
              LIMIT 100
1086
1087
      head = <table class="table table-condensed table-hover"><tr>
                 <th>Id</th><th>grId</th><th>xId</th><th>To</th><th>From</th><th>Date</th><th>E-Mail</th></tr>
1088
1089
1090
1091
1092
      tail = </table>
      rbeg = <tr><td>
      rend = </td></tr>
    }

1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
.. _REDIRECT_ALL_MAIL_TO:

Redirect all mail to (catch all)
--------------------------------

Setup in configuration_

* *redirectAllMailTo=john@doe.com*

  * During the development, it might be helpful to configure a 'catch all' email address, which QFQ uses as the final receiver
    instead of the original intended one.

  * The setting will:

    * Replace the 'To' with the configured one.
    * Clear 'CC' and 'Bcc'
    * Write a note and the original configured receiver at the top of the email body.


Show log files realtime
-----------------------

Display QFQ log files in realtime.

The following QFQ code could be used for that purpose (put it in a QFQ PageContent element)::

   #
   # {{logfile:SU}}
   #

1123
   # Show buttons to select log file.
1124
1125
   10 {
     sql = SELECT '{{logfile:SU:::sql.log}}' AS '_=logfile'
Carsten  Rose's avatar
Carsten Rose committed
1126
1127
1128
     head = <p>
     tail = </p>

1129
1130
1131
     20.sql = SELECT CONCAT('p:{{pageAlias:T}}&logfile=sql.log|t:sql.log|b:', IF('{{logfile:R}}'='sql.log','primary','')) AS _page, ' ',
                     CONCAT('p:{{pageAlias:T}}&logfile=qfq.log|t:qfq.log|b:', IF('{{logfile:R}}'='qfq.log','primary','')) AS _page, ' ',
                     CONCAT('p:{{pageAlias:T}}&logfile=mail.log|t:mail.log|b:', IF('{{logfile:R}}'='mail.log','primary','')) AS _page
1132
1133
1134
   }

   # Show selected log file.
1135
1136
1137
1138
   100 {
     sql = SELECT 'file:fileadmin/protected/log/{{logfile:R}}' AS _monitor
     head = <pre id="monitor-1">Please wait</pre>
   }
1139
1140


Carsten  Rose's avatar
Carsten Rose committed
1141
.. _`form-submit-log-page`:
1142
1143
1144
1145
1146

Form Submit Log page
--------------------

For debugging purposes you may like to add a Form Submit Log page in the frontend.
1147
The following QFQ code could be used for that purpose (put it in a QFQ PageContent element)::
1148
1149

    # Filters
1150
    20.shead = <form onchange='this.submit()' class='form-inline'><input type='hidden' name='id' value='{{pageAlias:T0}}'>
1151
    20 {
1152
      sql = SELECT "'", id, IF(id = '{{formId:SC0}}', "' selected>", "'>"), name
1153
1154
1155
            FROM Form ORDER BY name
      head = <label for='formId'>Form:</label> <select name='formId' id='formId' class='form-control'><option value=0></option>
      tail = </select>
1156
      rbeg = <option value=
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
      rend = </option>
    }
    30 {
      sql = SELECT feUser, IF(feUser = '{{feUser:SCE:alnumx}}', "' selected>", "'>"), feUser
            FROM FormSubmitLog GROUP BY feUser ORDER BY feUser
      head = <label for='feUser'>FE User:</label> <select name='feUser' id='feUser' class='form-control'><option value=''></option>
      tail = </select>
      rbeg = <option value='
      rend = </option>
    }
    30.stail = </form>

    # Show Log
    50 {
      sql = SELECT l.id,
          CONCAT('<b>Form</b>: ', f.name,
            '<br><b>Record Id</b>: ', l.recordId,
            '<br><b>Fe User</b>: ', l.feUser,
            '<br><b>Date</b>: ', l.created,
            '<br><b>Page Id</b>: ', l.pageId,
            '<br><b>Session Id</b>: ', l.sessionId,
            '<br><b>IP Address</b>: ', l.clientIp,
            '<br><b>User Agent</b>: ', l.userAgent,
            '<br><b>SIP Data</b>: <div style="margin-left:20px;">', "<script>var data = JSON.parse('", l.sipData,
              "'); for (var key in data) {
              document.write('<b>' + key + '</b>: ' + data[key] + '<br>'); }</script>", '</div>'),
          CONCAT("<script>var data = JSON.parse('", l.formData,
            "'); for (var key in data) {
              document.write('<b>' + key + '</b>: ' + data[key] + '<br>'); }</script>")
          FROM FormSubmitLog AS l
          LEFT JOIN Form AS f ON f.id = l.formId
          WHERE (l.formId = '{{formId:SC0}}' OR '{{formId:SC0}}' = 0)
            AND (l.feUser = '{{feUser:SCE:alnumx}}' OR '{{feUser:SCE:alnumx}}' = '')