Manual.rst 466 KB
Newer Older
1
.. ==================================================
2
.. Header hierarchy
3
4
5
.. ==
..  --
..   ^^
6
..    ""
7
8
9
10
..     ;;
..      ,,
..
.. --------------------------------------------------
11
.. Best Practice T3 reST  https://docs.typo3.org/typo3cms/drafts/github/xperseguers/RstPrimer/
Carsten  Rose's avatar
Carsten Rose committed
12
.. Italic *italic*are part of key or value
13
14
.. Bold **bold**
.. Code ``text``
15
.. External Links: `Bootstrap <http://getbootstrap.com/>`_
16
.. Add Images: https://wiki.typo3.org/ReST_Syntax#Images ...
17
..
18
19
.. Admonitions (https://docs.typo3.org/typo3cms/drafts/github/xperseguers/RstPrimer/#admonitions)
..       .. note::    .. important::     .. tip::      .. warning::
Carsten  Rose's avatar
Carsten Rose committed
20
.. Color:   (grey)       (orange)           (green)      (red)
21
..
22
23
24
25
.. Definition:
.. some text becomes strong (only one line)
..      description has to indented

26
27
28
29
30
.. -*- coding: utf-8 -*- with BOM.


.. include:: Includes.txt

31
32
33
34
35
.. _general:

General
=======

36
* Project homepage: https://qfq.io
Carsten  Rose's avatar
Carsten Rose committed
37
* Latest releases: https://qfq.io/download
38
* Development: https://git.math.uzh.ch/typo3/qfq
39
* Slack: https://qfq-io.slack.com
40
41
42
43
44
45

.. _installation:

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

46
The following features are only tested / supported on linux hosts:
47

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

53

54
55
.. _`preparation`:

56
57
58
59
60
61
Preparation
-----------

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

62
To normalize UTF8 input, *php-intl* package is needed by
63
64
65

* normalizer::normalize()

66
For the `download`_ function, the programs `pdftk` and `file` are necessary to concatenate PDF files.
67

68
Preparation for Ubuntu::
69

70
  sudo apt install php-intl
71
72
  sudo apt install pdftk libxrender1 file pdf2svg  # for file upload, PDF and 'HTML to PDF' (wkhtmltopdf), PDF split
  sudo apt install inkscape imagemagick            # to render thumbnails
73

74
.. _wkhtml:
75

76
77
wkhtmltopdf
^^^^^^^^^^^
78

79
80
`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.
81

82
83
84
85
* 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'.
86
87
  * 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.
88

89
In `configuration`_ specify the::
90

91
92
    config.cmdWkhtmltopdf=/opt/wkhtmltox/bin/wkhtmltopdf`.
    config.baseUrl=http://www.example.com/`.
93

94
95
If wkhtml has been compiled with dedicated libraries (not part of LD_LIBRARY_PATH), specify the LD_LIBRARY_PATH together
with the path-filename: ::
96
97

    cmdWkhtmltopdf=LD_LIBRARY_PATH=/opt/wkhtmltox/lib /opt/wkhtmltox/bin/wkhtmltopdf
98

99
100
.. important::

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

Configure via Typo3 Installtool `All configuration > $TYPO3_CONF_VARS['FE']`: ::
105
106
107

   [FE][lockIP] = 0

108
109
110
111
112
113
.. 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.
114

115
116
If there are problems with converting/downloading FE_GROUP protected pages, check `SHOW_DEBUG_INFO = download` to debug.

117
118
119
120
.. note::

    Converting HTML to PDF gives no error message but RC=-1? Check carefully all includes of CSS, JS, images
    and so on! Typically some of them fails to load and wkhtml stops running!
121
122


123
HTML to PDF conversion
124
""""""""""""""""""""""
125
126
127
128

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

Print
129
"""""
130
131

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
132
`print.php` with uses `wkhtmltopdf` to convert HTML to PDF.
133

134
Provide a `print this page`-link (replace 'current pageId' )::
135

136
  <a href="typo3conf/ext/qfq/Source/api/print.php?id={current pageId}">Print this page</a>
137
138
139
140
141

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::

142
143
144
145
146
  10 = TEXT
  10 {
    wrap = <a href="typo3conf/ext/qfq/Source/api/print.php?id=|&type=99"><span class="glyphicon glyphicon-print" aria-hidden="true"></span> Printview</a>
    data = page:uid
  }
147

148
149
150
151
152
153
Send Email
^^^^^^^^^^

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

154
By default, `sendEmail` uses the local installed MTA, writes a logfile to `fileadmin/protected/log/mail.log` and handles attachments
155
156
157
158
159
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
160
Nevertheless, on latest system the TLS support is broken - please check sendEmailProblem_.
161

162
163
164
165
166
The Typo3 sendmail eco-system is not used at all by QFQ.

Thumbnail
^^^^^^^^^

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

170
The Typo3 graphic eco-system is not used at all by QFQ.
171

172
173
Usage: `column-thumbnail`_.

174
175
176
Setup
-----

Carsten  Rose's avatar
Carsten Rose committed
177
* Install the extension via the Extension Manager.
178
179

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

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

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

191
192
193
194
.. _setup-css-js:

Setup CSS & JS
^^^^^^^^^^^^^^
195
196
::

197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
    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
    }

    page.includeJS {
213
214
215
216
217
218
219
        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
220
        file08 = typo3conf/ext/qfq/Resources/Public/JavaScript/typeahead.bundle.min.js
221
222
223
224
        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
225

226
227
228
        # 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
229
    }
230

231

232
.. _form-editor:
233
234
235

FormEditor
----------
236

237
238
239
Setup a *report* to manage all *forms*:

* Create a Typo3 page.
240
* Set the 'URL Alias' to `form` (default) or the individual defined value in parameter `editFormPage` (configuration_).
241
* Insert a content record of type *qfq*.
242
* In the bodytext insert the following code::
243

244
245
    # If there is a form given by SIP: show
    form={{form:SE}}
246

247
248
    # In case indexQfq is different from indexData, set indexQfq.
    dbIndex = {{indexQfq:Y}}
249

250
251
252
    10 {
        # List of Forms: Do not show this list of forms if there is a form given by SIP.
        # Table header.
253
        sql = SELECT CONCAT('p:{{pageAlias:T}}&form=form') as _pagen, '#', 'Name', 'Title', 'Table', '' FROM (SELECT 1) AS fake WHERE '{{form:SE}}'=''
Carsten  Rose's avatar
Carsten Rose committed
254
        head = {{'b|p:id={{pageAlias:T}}&form=copyFormFromExt|t:Copy form from ExtForm' AS _link}}
255
               <table class="table table-hover qfq-table-50 tablesorter tablesorter-filter">
256
257
258
259
260
        tail = </table>
        rbeg = <thead><tr>
        rend = </tr></thead>
        fbeg = <th>
        fend = </th>
261

262
263
        10 {
            # All forms
264
            sql = SELECT CONCAT('p:{{pageAlias:T}}&form=form&r=', f.id) as _pagee
Carsten  Rose's avatar
Carsten Rose committed
265
                         , f.id, f.name, f.title AS '_striptags', f.tableName
266
267
268
                         , CONCAT('U:form=form&r=', f.id) as _paged
                      FROM Form AS f
                      ORDER BY f.name
269
270
271
272
273
274
            rbeg = <tr>
            rend = </tr>
            fbeg = <td>
            fend = </td>
        }
    }
275

276
277
.. _install-checklist:

Carsten  Rose's avatar
Carsten Rose committed
278
279
Installation: Check List
------------------------
280

281
282
283
* 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
284
  * `<T3 installation>/fileadmin/protected/log/...` is the default place for QFQ log files.
285

286
287
* 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`.
288
289
* 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.
290

291
292
293
294
295
.. _configuration:

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

296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
.. _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
312
313
| 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'                    |                                                                            |
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+


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
331
332
333
334
        //DB_2_USER => <DBUSER>
        //DB_2_SERVER => <DBSERVER>
        //DB_2_PASSWORD => <DBPW>
        //DB_2_NAME => <DB>
335
336
337
338

        // DB_n ...
        // ...

Carsten  Rose's avatar
Carsten Rose committed
339
340
        // LDAP_1_RDN => 'ou=Admin,ou=example,dc=com'
        // LDAP_1_PASSWORD => 'mySecurePassword'
341
342
    ];

343
344
345
346
347
.. _extension-manager-qfq-configuration:

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

348

349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| Keyword                           | Default / Example                                     | Description                                                                |
+===================================+=======================================================+============================================================================+
| Config                                                                                                                                                                 |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| 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    |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| flagProduction                    | yes                                                   | yes|no: used to differentiate production and development site.             |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| 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=...   |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| baseUrl                           | http://example.com                                    | URL where wkhtmltopdf will fetch the HTML (no parameter, those comes later)|
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| sendEMailOptions                  | -o tls=yes                                            | General options. Check: http://caspian.dotconf.net/menu/Software/SendEmail |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| dateFormat                        | yyyy-mm-dd                                            | Possible options: yyyy-mm-dd, dd.mm.yyyy.                                  |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| 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.                                                      |
391
|                                   |                                                       | | See `form-submit-log-page`_ for example QFQ code to display the log.     |
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| redirectAllMailTo                 | john@doe.com                                          | If set, redirect all QFQ generated mails (Form, Report) to the specified.  |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| sqlLogMode                        | modify                                                | | *all*: every statement will be logged - this might a lot.                |
|                                   |                                                       | | *modify*: log only statements who change data. *error*: log only         |
|                                   |                                                       |   DB errors.                                                               |
|                                   |                                                       | | *none*: no SQL log at all.                                               |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| 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`_.                                                     |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
440
441
| securityFailedAuthDelay           | 3                                                     | If authorization fails, sleep 'x' seconds before answering the request.    |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
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
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
| 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
491
| formLanguage[ABCD]Id              | E.g.: 1                                               | In Typo3 configured pageLanguage id. The number after the 'L' parameter.   |
492
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
Carsten  Rose's avatar
Carsten Rose committed
493
| formLanguage[ABCD]Label           | E.G.: english                                         | Label shown in *Form editor*, on the 'basic' tab.                          |
494
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
Carsten  Rose's avatar
Carsten Rose committed
495
| saveButtonText                    |                                                       | Text on the form save button. Typically none.                              |
496
497
498
499
500
501
502
503
504
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| 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.                    |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| saveButtonClassOnChange           | alert-info btn-info                                   | Bootstrap CSS class for save button showing 'data changed'.                |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| saveButtonGlyphIcon               | glyphicon-ok                                          | Icon for the form save button.                                             |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
Carsten  Rose's avatar
Carsten Rose committed
505
| closeButtonText                   |                                                       | Text on the form close button. Typically none.                             |
506
507
508
509
510
511
512
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| 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
513
| deleteButtonText                  |                                                       | Text on the form delete button. Typically none.                            |
514
515
516
517
518
519
520
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| 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
521
| newButtonText                     |                                                       | Text on the form new button. Typically none.                               |
522
523
524
525
526
527
528
529
530
531
532
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| 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.            |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
533

534
After parsing the configuration, the following variables will be set automatically in STORE_SYSTEM:
535
536
537
538

+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| Keyword                       | Description                                                                                                                        |
+===============================+====================================================================================================================================+
539
| dbNameData                    | Name of the 'data'-database. '{{dbNameData:Y}}                                                                                     |
540
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
541
| dbNameQfq                     | Name of the 'QFQ'-database. '{{dbNameQfq:Y}}                                                                                       |
542
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
543
544
| dbNameT3                      | Name of the 'T3'-database. '{{dbNameT3:Y}}                                                                                         |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
545
| sitePath                      | Absolute path of the current T3 instance. '{{sitePath:Y}}                                                                          |
546
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
547
| extPath                       | Absolute path of the QFQ extension. '{{extPath:Y}}                                                                                 |
548
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
549

550

551
552
553
554
.. _`CustomVariables`:

Custom variables
^^^^^^^^^^^^^^^^
555

556
Up to 30 custom variables can be defined in `configuration`_.
557

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

560
561
562
   custom1: ADMINISTRATIVE_CONTACT = john@doe.com
   custom2: ADMINISTRATIVE_ADDRESS = John Doe, Hollywood Blvd. 1, L.A.
   custom3: ADMINISTRATIVE_NAME = John Doe
563
564
565
566
567

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

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

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

Carsten  Rose's avatar
Carsten Rose committed
570
.. _`fillStoreSystemBySql`:
571

Carsten  Rose's avatar
Carsten Rose committed
572
573
Fill STORE_SYSTEM by SQL
^^^^^^^^^^^^^^^^^^^^^^^^
574

575
576
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
577
**added** to the existing STORE_SYSTEM. Existing variables will be overwritten. Be careful not to overwrite system values.
578

Carsten  Rose's avatar
Carsten Rose committed
579
580
581
582
583
584
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: ::

585
586
  fillStoreSystemBySql1: SELECT name FROM Person WHERE name='Doe'
  fillStoreSystemBySqlErrorMsg1: Too many or to few "Doe's" in our database
587

588
.. _`periodId`:
589
590

periodId
591
""""""""
592
593
594

This is

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

598
After a full QFQ installation:
599
600
601
602

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

603
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
604
*current* period.
605

606
In configuration_: ::
607

608
  fillStoreSystemBySql1: SELECT id AS periodId FROM Period WHERE start<=NOW() ORDER BY start DESC LIMIT 1
609
610
611
612
613
614
615
616

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: ::

617
618
  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}}
619
620
621
622

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

.. _`DbUserPrivileges`:
623
624
625
626
627
628
629
630

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

631
To get access to the Typo3 installation, 'dbuser' should also have access to the Typo3 Database with at least SELECT / INSERT / UPDATE / DELETE.
632
633
634



635
636
637
638
639
.. _`ExceptionMaxLength`:

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

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


645
646
647
648
649
650
651
.. _`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).

652
653
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
654
655
656
657
658
659
660
661
662
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.

663
664
665
666
667
.. _local-documentation:

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

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

670
671
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
672
673
server). For a development server instead, deactivate the forbid rule of 'documentation'. In `.htaccess` (snippet from
Typo3 7.6 _.htaccess): ::
674

675
676
  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]
677
678
679
680
681
682

.. _concept:

Concept
=======

683
684
685
686
687
SIPs
----

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

688
The SIPs (=Server Id Pairs) are uniq timestamps, created/registered on the fly for a specific browser session (=user). Every SIP is
689
registered on the server (= stored in a browser session) and contains one or more key/value pairs. The key/value pairs never leave
690
691
692
693
694
695
696
697
698
699
700
701
702
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.
703
704
705
706
707

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

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

709
710
711
712
713
714
715
* 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
716
717
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.
718
719
720
721
722
723

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

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

724
725
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.
726
727
728
729

QFQ Keywords (Bodytext)
^^^^^^^^^^^^^^^^^^^^^^^

730
731
**All of the named parameter are optional.**

732
733
734
 +-------------------+---------------------------------------------------------------------------------+
 | Name              | Explanation                                                                     |
 +===================+=================================================================================+
735
736
737
738
739
740
741
742
743
 | 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.                              |
744
 +-------------------+---------------------------------------------------------------------------------+
745
746
747
748
 | 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   |
749
 +-------------------+---------------------------------------------------------------------------------+
750
751
752
 | sqlLog            | Overwrites configuration_: `SQL_LOG`_ . Only affects `Report`, not `Form`.      |
 +-------------------+---------------------------------------------------------------------------------+
 | sqlLogMode        | Overwrites configuration_: `SQL_LOG_MODE`_ . Only affects `Report`, not `Form`. |
753
754
755
756
757
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.fbeg      | Start token for every field (=column)                                           |
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.fend      | End token for every field (=column)                                             |
 +-------------------+---------------------------------------------------------------------------------+
758
 | <level>.shead     | Static start token for whole <level>, independent if records are selected       |
759
 |                   | Shown before `head`.                                                            |
760
 +-------------------+---------------------------------------------------------------------------------+
761
 | <level>.stail     | Static end token for whole <level>, independent if records are selected.        |
762
 |                   | Shown after `tail`.                                                             |
763
764
765
766
 +-------------------+---------------------------------------------------------------------------------+
 | <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.     |
767
768
769
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.rbeg      | Start token for row.                                                            |
 +-------------------+---------------------------------------------------------------------------------+
770
 | <level>.rbgd      | Alternating (per row) token.                                                    |
771
772
773
774
775
776
777
778
779
780
781
 +-------------------+---------------------------------------------------------------------------------+
 | <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>.fsep      | Seperator token between fields (=columns)                                       |
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.sql       | SQL Query                                                                       |
 +-------------------+---------------------------------------------------------------------------------+
782
783
784
 | <level>.althead   | If <level>.sql is empty, these token will be rendered.                          |
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.altsql    | If <level>.sql is empty, these query will be fired. No sub queries.             |
785
 |                   | Shown after `althead`                                                           |
786
 +-------------------+---------------------------------------------------------------------------------+
787
788
789
790
 | <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.           |
 |                   | | *store*: content of current and sub levels are stored and shown.              |
 |                   | | To retrieve the content: `{{<level>.line.content}}`. See `syntax-of-report`_  |
791
 +-------------------+---------------------------------------------------------------------------------+
792

793
794
795
796
797
798
799
800
.. _`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
801
When QFQ is called, it checks for QFQ system tables. If they do not exist or have a lower version than the installed QFQ
802
803
804
805
806
807
808
version, the system tables will be automatically installed or updated.

.. _`system-tables`:

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

809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
+---------------+------------+------------+
| 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       |
+---------------+------------+------------+

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

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

835
836
837
838
.. _`multi-database`:

Multi Database
^^^^^^^^^^^^^^
839

840
Base: T3 & QFQ
841
""""""""""""""
842

843
844
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
845
no problems on Typo3 updates and to have a clean separation between Typo3 and QFQ.
846
847

QFQ: System & Data
848
""""""""""""""""""
849

Carsten  Rose's avatar
Carsten Rose committed
850
851
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.
852
853
854
855

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

Data: Data1, Data2, ..., Data n
856
"""""""""""""""""""""""""""""""
857

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

860
861
862
`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.
863
864

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

866
867
868

A `Form` will:

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

874
875
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'
876

877
To separate QFQ system and data, indexQfq and indexData will have different indexes.
878
879
880
881
882
883
884


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.
885

886
Note:
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908

* 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 |
+---+----------------+--------------+-------------------------------+------------------------------+----------------------------------+

909
In config-qfq-php_ mutliple database credentials can be prepared. Mandatory is at least one credential setup like
910
911
912
`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.

913
Typically the credentials for `DB_1`  also have access to the T3 database.
914
915
916
917
918
919


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
920
'QFQ system' tables. Best is to always use the same QFQ version on all instances or use a Multi Database setup.
921

922
923
924
.. _debug:

Debug
925
926
927
928
=====

SQL Logging
-----------
929

930
Setup in configuration_
931
932
933

.. _SQL_LOG:

934
* *sqlLog*
935
936

  * Filename where to log SQL queries and statistical data.
937
  * File is relative to the `<site path>` or absolute (starting with '/').
938
939
940
  * 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.
941

942
943
944

.. _SQL_LOG_MODE:

945
* *sqlLogMode: all|modify|error|none*
946
947
948
949
950
951
952

  * *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.

953
* *showDebugInfo = [yes|no|auto],[download]*
954
955

  If active, displays additional information in the Frontend (FE). This is typically helpful during development.
956
957
958
959
960
961

  * *yes*:

    * Form:

      * For every internal link/button, show tooltips with decoded SIP on mouseover.
962
      * Shows an 'Edit form'-button (wrench symbol) on a form. The link points to the T3 page with the :ref:`form-editor`.
963
964
965
966
967
968
969
970
971

    * 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:

972
973
    * *showDebugInfo = yes*  (BE session exist)
    * *showDebugInfo = no*   (no BE session)
974

975
976
977
  * *download*:

    * During a download (especially by using wkhtml), temporary files are not deleted automatically. Also the
978
      ``wkhtmltopdf`` and ``pdftk`` commandlines will be logged to `SQL_LOG`_. Use this only to debug problems on download.
979

980
981
.. _REDIRECT_ALL_MAIL_TO:

982
983
984
Redirect all mail to (catch all)
--------------------------------

985
Setup in configuration_
986

987
* *redirectAllMailTo=john@doe.com*
988
989
990
991
992
993
994
995
996

  * 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.
997

998
_`mail-log-page`
999
1000
1001
1002
1003

Mail Log page
-------------

For debugging purposes you may like to add a Mail Log page in the frontend.
1004
The following QFQ code could be used for that purpose (put it in a QFQ PageContent element)::
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015

    # 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 {
      sql = SELECT gr.id, IF(gr.id = @grId, "' selected>", "'>"), gr.value, ' (Id: ', gr.id, ')'
               FROM gGroup AS gr
               INNER JOIN MailLog AS ml ON ml.grId = gr.id
               GROUP BY gr.id
1016
1017
      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>
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
      rbeg = <option value='
      rend = </option>
      tail = </select>
    }
    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;">',
1033
1034
1035
                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>'))) )
1036
1037
1038
              FROM MailLog WHERE (grId = @grId OR @grId = 0)
              ORDER BY modified DESC
              LIMIT 100
1039
1040
      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>
1041
1042
1043
1044
1045
      tail = </table>
      rbeg = <tr><td>
      rend = </td></tr>
    }

1046
_`form-submit-log-page`
1047
1048
1049
1050
1051

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

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

    # Filters
1055
    20.shead = <form onchange='this.submit()' class='form-inline'><input type='hidden' name='id' value='{{pageAlias:T0}}'>
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
    20 {
      sql = SELECT id, IF(id = '{{formId:SC0}}', "' selected>", "'>"), name
            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>
      rbeg = <option value='
      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}}' = '')
          ORDER BY l.created DESC LIMIT 100
      head = <table class="table table-hover">
             <tr><th>Id</th><th style="min-width:250px;">Environment</th><th>Submitted Data</th>
      tail = </table>
      rbeg = <tr>
      renr = </tr>
      fbeg = <td>
      fend = </td>
    }

1105
1106
.. _variables:

1107
1108
Variable
========
1109

1110
1111
Variables in QFQ are surrounded by double curly braces. Four different types of variable substitution functionality is
provided. Access to:
1112

1113
1114
* `store-variables`_
* `sql-variables`_
1115
1116
* `row-column-variables`_
* `link-column-variables`_
1117

1118
Some examples, including nesting::
1119

1120
1121
1122
1123
  # Store
  #---------------------------------------------
  {{r}}
  {{index:FS}}
1124
  {{name:FS:alnumx:s:my default}}
1125

1126
1127
1128
  # SQL
  #---------------------------------------------
  {{SELECT name FROM person WHERE id=1234}}
1129

1130
  # Row columns
1131
1132
1133
  #---------------------------------------------
  {{10.pId}}
  {{10.20.pId}}
1134

1135
1136
1137
1138
1139
  # Nesting
  #---------------------------------------------
  {{SELECT name FROM person WHERE id={{r}} }}
  {{SELECT name FROM person WHERE id={{key1:C:alnumx}} }} # explained below
  {{SELECT name FROM person WHERE id={{SELECT id FROM pf LIMIT 1}} }} # it's more efficient to use only one query
1140

1141
1142
  # Link Columns
  {{p:form=Person&r=1|t:Edit Person|E|s AS link}}
1143

1144
Leading and trailing spaces inside curly braces are removed.
1145

1146
1147
  * *{{ SELECT "Hello World"   }}* becomes *{{SELECT "Hello World"}}*
  * *{{ varname   }}* becomes *{{varname}}*
1148

1149
1150
Types
-----
1151

1152
.. _`store-variables`:
1153

1154
1155
Store variables
^^^^^^^^^^^^^^^
1156

1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
Syntax:  *{{VarName[:<store(s)[:<sanitize class>[:<escape>[:<default value>[:type violate message]]]]]}}*

See also:

 * `store`_
 * `sanitize-class`_
 * `variable-escape`_
 * `variable-default`_
 * `variable-type-message-violate`_

1167

1168
* Example::
1169

1170
1171
1172
  {{pId}}
  {{pId:FSE}}
  {{pId:FSE:digit}}
1173
  {{pId::digit}}
1174
  {{name:FSE:alnumx:m}}
1175
  {{name:::m}}
1176
  {{name:FSE:alnumx:m:John Doe}}
1177
1178
1179
  {{name::::John Doe}}
  {{name:FSE:alnumx:m:John Doe:forbidden characters}}
  {{name:::::forbidden characters}}
1180

1181
* Zero or more stores might be specified to be searched for the given VarName.
1182
* If no store is specified, the default for the searched stores are: **FSRVD** (=FORM > SIP > RECORD > VARS > DEFAULT).
1183
* If the VarName is not found in one store, the next store is searched,  up to the last specified store.
1184
1185
* If the VarName is not found and a default value is given, the default is returned.
* If no value is found, nothing is replaced - the string '{{<VarName>}}' remains.
1186
* If anywhere along the line an empty string is found, this **is** a value: therefore, the search will stop.
1187

1188
.. _`sanitize-class`:
1189

1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
Sanitize class
--------------

Values in STORE_CLIENT *C* (Client=Browser) and STORE_FORM *F* (Form, HTTP 'post') are checked against a
sanitize class. Values from other stores are *not* checked against any sanitize class, even if a sanitize class is specified.

* Variables get by default the sanitize class defined in the corresponding `FormElement`. If not defined,
  the default class is 'digit'.
* A default sanitize class can be overwritten by individual definition: *{{a:C:alnumx}}*
* If a value violates the specific sanitize class, see `variable-type-message-violate`_ for default or customized message.
  By default the value becomes `!!<name of sanitize class>!!`. E.g. `!!digit!!`.

For QFQ variables and FormElements:

+------------------+------+-------+-----------------------------------------------------------------------------------------+
| Name             | Form | Query | Pattern                                                                                 |
+==================+======+=======+=========================================================================================+
| **alnumx**       | Form | Query | [A-Za-z][0-9]@-_.,;: /() ÀÈÌÒÙàèìòùÁÉÍÓÚÝáéíóúýÂÊÎÔÛâêîôûÃÑÕãñõÄËÏÖÜŸäëïöüÿç            |
+------------------+------+-------+-----------------------------------------------------------------------------------------+
| **digit**        | Form | Query | [0-9]                                                                                   |
+------------------+------+-------+-----------------------------------------------------------------------------------------+
| **numerical**    | Form | Query | [0-9.-+]                                                                                |
+------------------+------+-------+-----------------------------------------------------------------------------------------+
| **allbut**       | Form | Query | All characters allowed, but not [ ]  { } % \ #. The used regexp: '^[^\[\]{}%\\#]+$',    |
+------------------+------+-------+-----------------------------------------------------------------------------------------+
| **all**          | Form | Query | no sanitizing                                                                           |
+------------------+------+-------+-----------------------------------------------------------------------------------------+


Only in FormElement:

+------------------+------+-------+-------------------------------------------------------------------------------------------+
| **auto**         | Form |       | Only supported for FormElements. Most suitable checktype is dynamically evaluated based   |
|                  |      |       | on native column definition, the FormElement type, and other info. See below for details. |
+------------------+------+-------+-------------------------------------------------------------------------------------------+
| **email**        | Form | Query | [a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}                                           |
+------------------+------+-------+-------------------------------------------------------------------------------------------+
| **pattern**      | Form |       | Compares the value against a regexp.                                                      |
+------------------+------+-------+-------------------------------------------------------------------------------------------+


Rules for CheckType Auto (by priority):

* TypeAheadSQL or TypeAheadLDAP defined: **alnumx**
* Table definition
1235
1236
  * integer type: **digit**
  * floating point number: **numerical**
1237
* FE Type
1238
1239
  * 'password', 'note': **all**
  * 'editor', 'text' and encode = 'specialchar': **all**
1240
1241
1242
1243
1244
1245
1246
1247
* None of the above: **alnumx**


.. _`variable-escape`:

Escape
------