Manual.rst 432 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/
12
13
14
15
16
17
18
19
.. External Links: `Bootstrap <http://getbootstrap.com/>`_:
.. Add Images: https://wiki.typo3.org/ReST_Syntax#Images
..
.. -*- coding: utf-8 -*- with BOM.


.. include:: Includes.txt

20
21
22
23
24
.. _general:

General
=======

25
* Project homepage: https://qfq.io
Carsten  Rose's avatar
Carsten Rose committed
26
* Latest releases: https://qfq.io/download
27
* Development: https://git.math.uzh.ch/typo3/qfq
28
* Slack: https://qfq-io.slack.com/
29
30
31
32
33
34

.. _installation:

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

35
The following features are only tested / supported on linux hosts:
36

37
* General: QFQ is coded to run on Linux hosts, preferable on Debian derivates like Ubuntu.
38
39
40
41
* HTML to PDF conversion - command `wkhtmltopdf`.
* Concatenation of PDF files - command `pdftk`.
* Mime type detection for uploads - command `file`.

42

43
44
.. _`preparation`:

45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
Preparation
-----------

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

In PHP 5.x the QFQ extension needs  the PHP MySQL native driver. The following functions are used and are only available with the
native driver (see also: http://dev.mysql.com/downloads/connector/php-mysqlnd/):

* mysqli::get_result (important),
* mysqli::fetch_all (nice to use)

To normalize UTF8 input, the *php5-intl* resp. *php7.0-intl* package is needed by

* normalizer::normalize()

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

63
64
Preparation for Ubuntu 14.04::

65
	sudo apt-get install php5-mysqlnd php5-intl
66
67
	sudo apt-get install pdftk file                  # for file upload and PDF
	sudo apt-get install inkscape graphicsmagick     # to render thumbnails
68
69
70
	sudo php5enmod mysqlnd
	sudo service apache2 restart

Carsten  Rose's avatar
Carsten Rose committed
71
Preparation for Ubuntu 16.04::
72

73
	sudo apt install php7.0-intl
74
75
	sudo apt install pdftk libxrender1 file pdf2svg  # for file upload, PDF and 'HTML to PDF' (wkhtmltopdf), PDF split
	sudo apt install inkscape graphicsmagick         # 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

92
In `configuration`_ specify the: ::
93

94
95
    cmdWkhtmltopdf=/opt/wkhtmltox/bin/wkhtmltopdf`.
    baseUrl=http://www.example.com/`.
96

97
98
If wkhtml has been compiled with dedicated libraries (not part of LD_LIBRARY_PATH), specify the LD_LIBRARY_PATH together
with the path-filename: ::
99
100

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

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

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

   [FE][lockIP] = 0

109
110
111
**Warning**: this 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
112
Typoscript) from specific IPs **or** if a FE-User is logged in.
113

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

116
117
118
119
**Important**: 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!


120
121
122
123
124
125
126
127
128
HTML to PDF conversion
''''''''''''''''''''''

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

Print
'''''

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

131
Provide a `print this page`-link (replace 'current pageId' )::
132
133
134
135
136
137
138
139
140

	<a href="typo3conf/ext/qfq/qfq/api/print.php?id={current pageId}">Print this page</a>

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

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

145
146
147
148
149
150
151
152
153
154
155
156
Send Email
^^^^^^^^^^

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

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

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

Thumbnail
^^^^^^^^^

Thumbnails will be rendered via GraphicsMagick (http://www.graphicsmagick.org/) 'convert' and 'inkscape' (https://inkscape.org).
'inkscape' is only used for '.svg' files.

The Typo3 grafic eco-system is not used at all by QFQ.
168

169
170
Usage: `column-thumbnail`_.

171
172
173
174
175
176
177
178
179
180
Setup
-----

* Install the extension via the Extensionmanager.

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

  * If the Extensionmanager stops after importing: check your memory limit in php.ini.

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

188
189
190
191
.. _setup-css-js:

Setup CSS & JS
^^^^^^^^^^^^^^
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
::

	page.meta {
	  X-UA-Compatible = IE=edge
	  X-UA-Compatible.attribute = http-equiv
	  viewport=width=device-width, initial-scale=1
	}

	page.includeCSS {
		file1 = typo3conf/ext/qfq/Resources/Public/Css/bootstrap.min.css
		file2 = typo3conf/ext/qfq/Resources/Public/Css/bootstrap-theme.min.css
		file3 = typo3conf/ext/qfq/Resources/Public/Css/jqx.base.css
		file4 = typo3conf/ext/qfq/Resources/Public/Css/jqx.bootstrap.css
		file5 = typo3conf/ext/qfq/Resources/Public/Css/qfq-bs.css
	}

	page.includeJS {
209
210
211
212
213
214
215
		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
216
        file08 = typo3conf/ext/qfq/Resources/Public/JavaScript/typeahead.bundle.min.js
217
218
219
220
		file09 = typo3conf/ext/qfq/Resources/Public/JavaScript/qfq.min.js

		# Only needed in case FormElement 'annotate' is used.
		file10 = typo3conf/ext/qfq/Resources/Public/JavaScript/fabric.min.js
Carsten  Rose's avatar
Carsten Rose committed
221
        file11 = typo3conf/ext/qfq/Resources/Public/JavaScript/qfq.fabric.min.js
222
223
	}

224

225
.. _form-editor:
226
227
228

FormEditor
----------
229

230
231
232
Setup a *report* to manage all *forms*:

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

237
238
    # If there is a form given by SIP: show
    form={{form:SE}}
239

240
241
    # In case indexQfq is different from indexData, set indexQfq.
    dbIndex = {{indexQfq:Y}}
242

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

255
256
257
258
259
260
261
262
263
        10 {
            # All forms
            sql = SELECT CONCAT('p:{{pageId:T}}&form=form&r=', f.id) as _pagee, f.id, f.name, f.title, f.tableName, CONCAT('form=form&r=', f.id) as _Paged FROM Form AS f ORDER BY f.name
            rbeg = <tr>
            rend = </tr>
            fbeg = <td>
            fend = </td>
        }
    }
264

265
266
267
268
269
.. _install-checklist:

Install Check List
------------------

270
271
272
273
274
* 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.
  * `<T3 installation>/fileadmin/protected/log/...` is the default place for QFQ logfiles.

275
276
* 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`.
277
278
* 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.
279

280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
.. _configuration:

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

.. _extension-manager-qfq-configuration:

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

+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| 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    |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| 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.                                   |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
306
| cmdWkhtmltopdf                | /usr/bin/wkhtmltopdf                                  | PathFilename of wkhtmltopdf. Optional variables like LD_LIBRARY_PATH=...   |
307
308
309
310
311
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| 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 |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
312
| dateFormat                    | yyyy-mm-dd                                            | Possible options: yyyy-mm-dd, dd.mm.yyyy.                                  |
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| 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.                           |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| fillStoreSystemBySqlErrorMsg2 | 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                                                                                                                                                              |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| 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.                                                 |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
328
329
| 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.                                       |
330
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
331
332
333
334
| formSubmitLogMode             | all                                                   | *all*: every form submission will be logged.                               |
|                               |                                                       | *none*: no logging.                                                        |
|                               |                                                       | See `Form Submit Log page`_ for example qfq code to display the log.       |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
335
336
| 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.                                |
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| 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.                    |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| redirectAllMailTo             | john@doe.com                                          | If set, redirect all QFQ generated mails (Form, Report) to the specified.  |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| Database                                                                                                                                                           |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| dbInit                        | dbInit=set names utf8                                 | Global init for using the database.                                        |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| 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.                                           |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
352
| indexData                     | 1                                                     | Optional. Default: 1. Retrieve the current setting via {{_dbNameData:Y}}.  |
353
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
354
| indexQfq                      | 1                                                     | Optional. Default: 1. Retrieve the current setting via {{_dbNameQfq:Y}}.   |
355
356
357
358
359
360
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| Security                                                                                                                                                           |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| escapeTypeDefault             | m                                                     | All variables `{{...}}` get this escape class by default.                  |
|                               |                                                       | See `variable-escape`_.                                                    |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
361
| securityVarsHoneypot          | email,username,password                               | If empty: no check. All named variables will rendered as INPUT elements.   |
362
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
363
| securityAttackDelay           | 5                                                     | If an attack is detected, sleep 'x' seconds and exit PHP process.          |
364
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
365
| securityShowMessage           | true                                                  | If an attack is detected, show a message.                                  |
366
367
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| securityGetMaxLength          | 50                                                    | GET vars longer than 'x' chars triggers an `attack-recognized`.            |
368
|                               |                                                       | `ExceptionMaxLength`_.                                                     |
369
370
371
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| Form-Config                                                                                                                                                        |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
372
| recordLockTimeoutSeconds      | 900                                                   | Timeout for record locking. After this time, a record will be replaced.    |
373
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
374
| enterAsSubmit                 | enterAsSubmit = 1                                     | 0: off, 1: Pressing *enter* in a form means *save* and *close*.            |
375
376
377
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| editFormPage                  | form                                                  | T3 Pagealias to edit a form.                                               |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
378
| formDataPatternError          | please check pattern error                            | Customizable error message used in validator.js. 'pattern' violation.      |
379
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
380
| formDataRequiredError         | missing value                                         | Customizable error message used in validator.js. 'required' fields.        |
381
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
382
| formDataMatchError            | type error                                            | Customizable error message used in validator.js. 'match' retype mismatch.  |
383
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
384
| formDataError                 | generic error                                         | Customizable error message used in validator.js. 'no specific' given.      |
385
386
387
388
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| Form-Layout                                                                                                                                                        |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| cssClassQfqContainer          | container                                             | QFQ with own Bootstrap: 'container'.                                       |
389
|                               |                                                       | QFQ already nested in Bootstrap of mainpage: <empty>.                      |
390
391
392
393
394
395
396
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| 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.         |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
397
| formBsColumns                 | 12                                                    | The whole form will be wrapped in 'col-md-??'. Default is 12 for 100%.     |
398
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
399
| formBsLabelColumns            | 3                                                     | Default number of BS columns for the 'label'-column.                       |
400
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
401
| formBsInputColumns            | 6                                                     | Default number of BS columns for the 'input'-column.                       |
402
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
403
| formBsNoteColumns             | 3                                                     | Default number of BS columns for the 'note'-column.                        |
404
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
405
| extraButtonInfoInline         | <img src="info.png">                                  | Image for `extraButtonInfo`_ (inline).                                     |
406
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
407
| extraButtonInfoBelow          | <img src="info.png">                                  | Image for `extraButtonInfo`_ (below).                                      |
408
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
409
| extraButtonInfoPosition       | below                                                 | 'auto' (default) or 'below'. See `extraButtonInfo`_.                       |
410
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
411
| extraButtonInfoClass          | pull-right                                            | '' (default) or 'pull-right'. See `extraButtonInfo`_.                      |
412
413
414
415
416
417
418
419
420
421
422
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| Form-Language                                                                                                                                                      |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| formLanguage[ABCD]Id          | -  E.g.: 1                                            | In Typo3 configured pageLanguage id. The number after the 'L' parameter.   |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| formLanguage[ABCD]Label       | -  E.G.: english                                      | Label shown in *Form editor*, on the 'basic' tab.                          |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| saveButtonText                | -                                                     | Text on the form save button. Typically none.                              |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| saveButtonTooltip             | Save                                                  | Tooltip on the form save button.                                           |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
423
| saveButtonClass               | btn btn-default navbar-btn                            | Bootstrap CSS class for save button on top of the form.                    |
424
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
425
| saveButtonClassOnChange       | alert-info btn-info                                   | Bootstrap CSS class for save button showing 'data changed'.                |
426
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
427
| saveButtonGlyphIcon           | glyphicon-ok                                          | Icon for the form save button.                                             |
428
429
430
431
432
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| closeButtonText               | -                                                     | Text on the form close button. Typically none.                             |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| closeButtonTooltip            | close                                                 | Tooltip on the form close button.                                          |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
433
| closeButtonClass              | btn btn-default navbar-btn                            | Bootstrap CSS class for close button on top of the form.                   |
434
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
435
| closeButtonGlyphIcon          | glyphicon-remove                                      | Icon for the form close button.                                            |
436
437
438
439
440
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| deleteButtonText              | -                                                     | Text on the form delete button. Typically none.                            |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| deleteButtonTooltip           | delete                                                | Tooltip on the form delete button.                                         |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
441
| deleteButtonClass             | btn btn-default navbar-btn                            | Bootstrap CSS class for delete button on top of the form.                  |
442
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
443
| deleteButtonGlyphIcon         | glyphicon-trash                                       | Icon for the form delete button.                                           |
444
445
446
447
448
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| newButtonText                 | -                                                     | Text on the form new button. Typically none.                               |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| newButtonTooltip              | new                                                   | Tooltip on the form new button.                                            |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
449
450
451
| 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.                                              |
452
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
453
| showIdInFormTitle             | 0 (off), 1 (on)                                       | Append at the form title the current record id.                            |
454
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
455
456
| cssClassColumnId              | text-muted                                            | A column in a subrecord with the name id|ID|Id gets this class.            |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
457
458


459
.. _config-qfq-php:
460

461
config.qfq.php
462
463
--------------

464
465
466
467
468
469
470
471
472
473
474
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| 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                                                              |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| LDAP_1_RDN                    | LDAP_1_RDN='ou=Admin,ou=example,dc=com'               | Credentials for non-anonymous LDAP access. At the moment only one set of   |
| LDAP_1_PASSWORD               | LDAP_1_PASSWORD=mySecurePassword                      |                                                                            |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
475
476
477
| T3_DB_NAME                    | T3_DB_NAME=specialt3dbname                            | Only necessary for inline report editing if the t3 database is not         |
|                               |                                                       | anologous to the Data db name (but ending in _t3) - see `inline-report`_.  |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
478

479

480

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

483
    <?php
484

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

489
490
491
492
493
    return [
        'DB_1_USER' => '<DBUSER>',
        'DB_1_SERVER' => '<DBSERVER>',
        'DB_1_PASSWORD' => '<DBPW>',
        'DB_1_NAME' => '<DB>',
494

495
496
497
498
        //DB_2_USER = <DBUSER>
        //DB_2_SERVER = <DBSERVER>
        //DB_2_PASSWORD = <DBPW>
        //DB_2_NAME = <DB>
499

500
501
        // DB_n ...
        // ...
502

503
504
505
        // LDAP_1_RDN =
        // LDAP_1_PASSWORD =
    ];
506

507
508
After parsing the configuration, the following variables will be set automatically in STORE_SYSTEM:

509
510
511
512
513
+----------------+------------------------------------------------------------------------------------+
| _dbNameData    | Can be used to dynamically access the current selected database: {{_dbNameData:Y}} |
+----------------+------------------------------------------------------------------------------------+
| _dbNameQfq     | Can be used to dynamically access the current selected database: {{_dbNameQfq:Y}}  |
+----------------+------------------------------------------------------------------------------------+
514

515
516
517
518
.. _`CustomVariables`:

Custom variables
^^^^^^^^^^^^^^^^
519

520
Up to 30 custom variables can be defined in `configuration`_.
521

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

524
525
526
   custom1: ADMINISTRATIVE_CONTACT = john@doe.com
   custom2: ADMINISTRATIVE_ADDRESS = John Doe, Hollywood Blvd. 1, L.A.
   custom3: ADMINISTRATIVE_NAME = John Doe
527
528
529
530
531

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

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

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

Carsten  Rose's avatar
Carsten Rose committed
534
.. _`fillStoreSystemBySql`:
535

Carsten  Rose's avatar
Carsten Rose committed
536
537
Fill STORE_SYSTEM by SQL
^^^^^^^^^^^^^^^^^^^^^^^^
538

539
540
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
541
**added** to the existing STORE_SYSTEM. Existing variables will be overwritten. Be careful not to overwrite system values.
542

Carsten  Rose's avatar
Carsten Rose committed
543
544
545
546
547
548
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: ::

549
550
  fillStoreSystemBySql1: SELECT name FROM Person WHERE name='Doe'
  fillStoreSystemBySqlErrorMsg1: Too many or to few "Doe's" in our database
551

552
.. _`periodId`:
553
554
555
556
557
558

periodId
''''''''

This is

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

562
After a full QFQ installation:
563
564
565
566

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

567
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
568
*current* period.
569

570
In configuration_: ::
571

572
	fillStoreSystemBySql1: SELECT id AS periodId FROM Period WHERE start<=NOW() ORDER BY start DESC LIMIT 1
573
574
575
576
577
578
579
580
581
582
583
584
585

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

  SELECT CONCAT('id={{pageId:T}}&periodId=', {{periodId:SY0}}-1, '|Next') AS _Page, ' ', name, ' ', CONCAT('id={{pageId:T}}&periodId=', {{periodId:SY0}}+1, '|Next') AS _Page FROM Period AS s WHERE s.id={{periodId:SY0}}

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

.. _`DbUserPrivileges`:
586
587
588
589
590
591
592
593
594
595
596
597

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

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



598
599
600
601
602
.. _`ExceptionMaxLength`:

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

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


608
609
610
611
612
.. _local-documentation:

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

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

615
616
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
617
618
server). For a development server instead, deactivate the forbid rule of 'documentation'. In `.htaccess` (snippet from
Typo3 7.6 _.htaccess): ::
619

620
621
  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]
622
623
624
625
626
627

.. _concept:

Concept
=======

628
629
630
631
632
SIPs
----

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

633
The SIPs (=Server Id Pairs) are uniq timestamps, created/registered on the fly for a specific browser session (=user). Every SIP is
634
635
636
637
638
639
640
641
642
643
644
645
646
647
registered on the server (= stored in a PHP Session) and contains one or more key/value pairs. The key/value pairs never leave
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.
648
649
650
651
652

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

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

654
655
656
657
658
659
660
* 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
661
662
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.
663
664
665
666
667
668

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

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

669
670
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.
671
672
673
674
675
676
677
678

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

 +-------------------+---------------------------------------------------------------------------------+
 | Name              | Explanation                                                                     |
 +===================+=================================================================================+
 | form              | Formname defined in ttcontent record bodytext                                   |
679
 |                   | - Fix. E.g.: **form = person**                                                  |
680
 |                   | - by SIP: **form = {{form:SE}}**                                                |
681
 |                   | - by SQL: **form = {{SELECT c.form FROM conference AS c WHERE c.id={{a:C}} }}** |
682
683
 +-------------------+---------------------------------------------------------------------------------+
 | r                 | <record id> The form will load the record with the specified id                 |
684
685
 |                   | - Variants: **r = 123**, by SQL: **r = {{SELECT ...}}**                         |
 |                   | - If not specified, the default is '0'                                          |
686
687
688
689
690
691
692
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.db        | Select a DB. Only necessary if a different than the standard DB should be used. |
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.fbeg      | Start token for every field (=column)                                           |
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.fend      | End token for every field (=column)                                             |
 +-------------------+---------------------------------------------------------------------------------+
693
 | <level>.shead     | Static start token for whole <level>, independent if records are selected       |
694
 |                   | Shown before `head`.                                                            |
695
 +-------------------+---------------------------------------------------------------------------------+
696
 | <level>.stail     | Static end token for whole <level>, independent if records are selected.        |
697
 |                   | Shown after `tail`.                                                             |
698
699
700
701
 +-------------------+---------------------------------------------------------------------------------+
 | <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.     |
702
703
704
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.rbeg      | Start token for row.                                                            |
 +-------------------+---------------------------------------------------------------------------------+
705
 | <level>.rbgd      | Alternating (per row) token.                                                    |
706
707
708
709
710
711
712
713
714
715
716
 +-------------------+---------------------------------------------------------------------------------+
 | <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                                                                       |
 +-------------------+---------------------------------------------------------------------------------+
717
718
719
 | <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.             |
720
 |                   | Shown after `althead`                                                           |
721
 +-------------------+---------------------------------------------------------------------------------+
722
 | debugShowBodyText | If='1' and configuration_:*showDebugInfo: yes*, shows a tooltip with bodytext   |
723
 +-------------------+---------------------------------------------------------------------------------+
724
 | sqlLog            | Overwrites configuration_: `SQL_LOG`_ . Only affects `Report`, not `Form`.      |
725
 +-------------------+---------------------------------------------------------------------------------+
726
 | sqlLogMode        | Overwrites configuration_: `SQL_LOG_MODE`_ . Only affects `Report`, not `Form`. |
727
728
 +-------------------+---------------------------------------------------------------------------------+

729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
.. _`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'.

When QFQ is called, it checks for QFQ system tables. If they do not exist or have a lower version than the installed qfq
version, the system tables will be automatically installed or updated.

.. _`system-tables`:

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

745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
+---------------+------------+------------+
| 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       |
+---------------+------------+------------+

See `Mail Log page`_ and `Form Submit Log page`_ for some Frontend views for these tables.
768
769

* Check Bug #5459 - support of system tables in different DBs not supported.
770

771
772
773
774
.. _`multi-database`:

Multi Database
^^^^^^^^^^^^^^
775

776
777
Base: T3 & QFQ
''''''''''''''
778

779
780
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
781
no problems on Typo3 updates and to have a clean separation between Typo3 and QFQ
782
783
784
785
786
787
788
789
790
791
792
793

QFQ: System & Data
''''''''''''''''''

QFQ itself can be separated in 'QFQ system' (see `system-tables`_) and 'QFQ data' databases (>=1). The 'QFQ system' stores
the forms, record locking, log tables and so on - `QFQ data` is for the rest.

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

Data: Data1, Data2, ..., Data n
'''''''''''''''''''''''''''''''

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

796
797
798
`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.
799
800

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

802
803
804

A `Form` will:

805
* load the own definition from `indexQfq` (table `Form` and `FormElement`),
806
* loads and save data from/in `indexData` (config.qfq.php) / `dbIndex` (form.parameter.dbIndex),
807
* retrieve extra information via `dbIndexExtra` - this is useful to offer information from a database and save them in a
808
  different one.
809

810
811
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'
812

813
To separate QFQ system and data, indexQfq and indexData will have different indexes.
814
815
816
817
818
819
820


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

822
Note:
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844

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

845
In config-qfq-php_ mutliple database credentials can be prepared. Mandatory is at least one credential setup like
846
847
848
`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.

849
Typically the credentials for `DB_1`  also have access to the T3 database.
850
851
852
853
854
855


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

When using different QFQ versions and a shared 'QFQ data'-database, there is some risk of conflicting
856
'QFQ system' tables. Best is to always use the same QFQ version on all instances ot use a Multi Database setup.
857

858
859
860
.. _debug:

Debug
861
862
863
864
=====

SQL Logging
-----------
865

866
configuration_
867
868
869

.. _SQL_LOG:

870
* *sqlLog*
871
872

  * Filename where to log SQL queries and statistical data.
873
  * File is relative to the `<site path>` or absolute (starting with '/').
874
875
876
  * 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.
877

878
879
880

.. _SQL_LOG_MODE:

881
* *sqlLogMode: all|modify|error|none*
882
883
884
885
886
887
888

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

889
* *showDebugInfo = [yes|no|auto],[download]*
890
891

  If active, displays additional information in the Frontend (FE). This is typically helpful during development.
892
893
894
895
896
897

  * *yes*:

    * Form:

      * For every internal link/button, show tooltips with decoded SIP on mouseover.
898
      * Shows an 'Edit form'-button (wrench symbol) on a form. The link points to the T3 page with the :ref:`form-editor`.
899
900
901
902
903
904
905
906
907

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

908
909
    * *showDebugInfo = yes*  (BE session exist)
    * *showDebugInfo = no*   (no BE session)
910

911
912
913
  * *download*:

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

916
917
.. _REDIRECT_ALL_MAIL_TO:

918
919
920
Redirect all mail to (catch all)
--------------------------------

921
configuration_
922

923
* *redirectAllMailTo=john@doe.com*
924
925
926
927
928
929
930
931
932

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

934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
_`Mail Log page`

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

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

    # 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
      head = <form onchange='this.submit();' class='form-inline'><input type='hidden' name='id' value='{{pageId:T0}}'>Filter By Group: <select name='grId' class='form-control'><option value=''></option>
      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;">',
                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>'))) )
              FROM MailLog WHERE (grId = @grId OR @grId = 0)
              ORDER BY modified DESC
              LIMIT 100
      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>
      tail = </table>
      rbeg = <tr><td>
      rend = </td></tr>
    }

_`Form Submit Log page`

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

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

    # Filters
    20.shead = <form onchange='this.submit()' class='form-inline'><input type='hidden' name='id' value='{{pageId:T0}}'>
    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>
    }

1037
1038
.. _variables:

1039
1040
Variable
========
1041

1042
1043
Variables in QFQ are surrounded by double curly braces. Four different types of variable substitution functionality is
provided. Access to:
1044

1045
1046
* `store-variables`_
* `sql-variables`_
1047
1048
* `row-column-variables`_
* `link-column-variables`_
1049

1050
Some examples, including nesting::
1051

1052
1053
1054
1055
  # Store
  #---------------------------------------------
  {{r}}
  {{index:FS}}
1056
  {{name:FS:alnumx:s:my default}}
1057

1058
1059
1060
  # SQL
  #---------------------------------------------
  {{SELECT name FROM person WHERE id=1234}}
1061

1062
  # Row columns
1063
1064
1065
  #---------------------------------------------
  {{10.pId}}
  {{10.20.pId}}
1066

1067
1068
1069
1070
1071
  # 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
1072

1073
1074
  # Link Columns
  {{p:form=Person&r=1|t:Edit Person|E|s AS link}}
1075

1076
Leading and trailing spaces inside curly braces are removed.
1077

1078
1079
  * *{{ SELECT "Hello World"   }}* becomes *{{SELECT "Hello World"}}*
  * *{{ varname   }}* becomes *{{varname}}*
1080

1081
1082
Types
-----
1083

1084
.. _`store-variables`:
1085

1086
1087
Store variables
^^^^^^^^^^^^^^^
1088

1089
Syntax:  *{{VarName[:<store / prio>[:<sanitize class>[:<escape>[:<default>]]]]}}*
1090

1091
* Example::
1092

1093
1094
1095
1096
  {{pId}}
  {{pId:FSE}}
  {{pId:FSE:digit}}
  {{name:FSE:alnumx:m}}
1097
  {{name:FSE:alnumx:m:John Doe}}
1098

1099
1100
1101
* Zero or more stores might be specified to be searched for the given VarName.
* If no store is specified, the by default searched stores are: **FSRVD** (=FORM > SIP > RECORD > VARS > DEFAULT).
* If the VarName is not found in one store, the next store is searched,  up to the last specified store.
1102
1103
* 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.
1104
* If anywhere along the line an empty string is found, this **is** a value: therefore, the search will stop.
1105

1106
See also:
1107

1108
1109
1110
 * `store`_
 * `variable-escape`_
 * `sanitize-class`_
1111

1112

1113
.. _`sql-variables`:
1114

1115
1116
SQL variables
^^^^^^^^^^^^^
1117

1118
1119
1120
* The detection of an SQL command is case *insensitive*.
* Leading  whitespace will be skipped.
* The following commands are interpreted as SQL commands:
1121

1122
1123
1124
  * SELECT
  * INSERT, UPDATE, DELETE, REPLACE, TRUNCATE
  * SHOW, DESCRIBE, EXPLAIN, SET
1125

1126
* A SQL Statement might contain variables, including additional SQL statements. Inner SQL queries will be executed first.
1127
1128
* All variables will be substituted one by one from inner to outer.
* The number of variables inside an input field or a SQL statement is not limited.
1129

1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
Result: string
''''''''''''''

A result of a SQL statement will be imploded over all: concat all columns of a row, concat all rows - there is no
glue string.

Result: row
'''''''''''

A few functionalities needs more than a returned string, instead separate columns are necessary. To indicate an array
result, specify those with an '!': ::

   {{!SELECT ...}}

This manual will specify the individual QFQ elements, who needs an array instead of a string. It's an error to return
a string where an array is needed and vice versa.

Database index
''''''''''''''

1150
1151
1152
1153
1154
To access different databases in a `multi-database`_  setup, the database index can be specified after the opening curly
braces. ::

	{{[1]SELECT ... }}

1155
For using the indexData and indexQfq (configuration_), it's a good practice to specify the variable name
1156
1157
instead of the numeric index. ::

1158
   {{[{{indexData:Y}}]SELECT ...}}
1159

1160
If no dbIndex is given, `{{indexData:Y}}` is used.
1161

Carsten  Rose's avatar
Carsten Rose committed
1162

1163
1164
1165
1166
Example
'''''''

::
1167

1168
  {{SELECT id, name FROM Person}}
Carsten  Rose's avatar
Carsten Rose committed
1169
1170
  {{SELECT id, name, IF({{feUser:T0}}=0,'Yes','No')  FROM Person WHERE id={{r:S}} }}
  {{SELECT id, city FROM Address AS adr WHERE adr.accId={{SELECT id FROM Account AS acc WHERE acc.name={{feUser:T0}} }} }}
1171
1172
  {{!SELECT id, name FROM Person}}
  {{[2]SELECT id, name FROM Form}}
1173
  {{[{{indexQfq:Y}}]SELECT id, name FROM Form}}
1174

1175
.. _`row-column-variables`:
1176

1177
1178
Row column variables
^^^^^^^^^^^^^^^^^^^^
1179
1180
1181

Syntax:  *{{<level>.<column>}}*

1182
Only used in report to access outer columns. See `access-column-values`_ and `syntax-of-report`_.
1183

1184
1185
There might be name conflicts between VarName / SQL keywords and <line identifier>. QFQ checks first for '<level>',
than for 'SQL keywords' and than for 'VarNames' in stores.
1186
1187
1188

All types might be nested with each other. There is no limit of nesting variables.

1189
1190
Very specific: Also, it's possible that the content of a variable is again (including curly braces) a variable - this
is sometimes used in text templates, where the template is retrieved from a record and
1191
1192
specific locations in the text will be (automatically by QFQ) replaced by values from other sources.

1193
1194
1195
General note: using this type of variables is only the second choice. First choice is `{{column:R}}` (see
`access-column-values`_) - using the STORE_RECORD is more portable cause no renumbering is needed if the level keys change.

1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206

.. _`link-column-variables`:

Link column variables
^^^^^^^^^^^^^^^^^^^^^

These variables return a link, completely rendered in HTML. The syntax and all features of `column-link`_ are available.
The following code will render a 'new person' button::

	{{p:form&form=Person|s|N|t:new person AS link}}

1207
For better reading, the format string might be wrapped in single or double quotes (this is optional): ::
1208
1209
1210
1211
1212
1213
1214
1215
1216

	{{"p:form&form=Person|s|N|t:new person" AS link}}

These variables are especially helpful in:

* `report`, to create create links or buttons outside of a SQL statement. E.g. in `head`, `rbeg`, ...
* `form`, to create links and buttons in labels or notes.


1217
.. _`sanitize-class`:
1218
1219

Sanitize class
1220
1221
--------------

1222
1223
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.
Carsten  Rose's avatar