Manual.rst 341 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
.. ==================================================
.. Header hierachy
.. ==
..  --
..   ^^
..    ''
..     ;;
..      ,,
..
.. --------------------------------------------------
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
26
* Latest relases: https://w3.math.uzh.ch/qfq/
27
* Development: https://git.math.uzh.ch/typo3/qfq
28

29
30
31
32
33
34

.. _installation:

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

35
36
37
38
39
40
The following features are only tested on linux hosts:

* HTML to PDF conversion - command `wkhtmltopdf`.
* Concatenation of PDF files - command `pdftk`.
* Mime type detection for uploads - command `file`.

41
42
.. _`preparation`:

43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
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()

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

61
62
Preparation for Ubuntu 14.04::

63
64
	sudo apt-get install php5-mysqlnd php5-intl
	sudo apt-get install pdftk file                # for file upload and PDF
65
66
67
	sudo php5enmod mysqlnd
	sudo service apache2 restart

Carsten  Rose's avatar
Carsten Rose committed
68
Preparation for Ubuntu 16.04::
69

70
	sudo apt install php7.0-intl
71
	sudo apt install pdftk libxrender1 file        # for file upload, PDF and 'HTML to PDF' (wkhtmltopdf)
72

73
.. _wkhtml:
74

75
76
wkhtmltopdf
^^^^^^^^^^^
77

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

81
82
83
84
* 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'.
85

86
In `config-qfq-ini`_ specify the:
87

88
89
90
91
92
93
94
95
* installed `wkhtmltopdf` binary:

  * `WKHTMLTOPDF = /.../wkhtmltopdf`

* the site base URL:

  * `BASE_URL_PRINT = http://example.com/`

96

97
98
**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.
99
100

Configure via Typo3 Installtool `All configuration > $TYPO3_CONF_VARS['FE']`: ::
101
102
103

   [FE][lockIP] = 0

104
105
106
107
108
**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
Typosript) from specific IPs **or** if a FE-User is logged in.

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

111
112
113
114
115
116
117
118
119
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
120
`print.php` with uses `wkhtmltopdf` to convert HTML to PDF.
121

122
123
124
125
126
127
128
129
130
131
Provide a `print this page`-link (replace {current pageId})::

	<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 {
132
		wrap = <a href="typo3conf/ext/qfq/qfq/api/print.php?id=|&type=2"><span class="glyphicon glyphicon-print" aria-hidden="true"></span> Printview</a>
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
		data = page:uid
	}

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.

* Enable the online local-documentation_.
* Copy/rename the file *<Documentroot>/typo3conf/ext/<ext_dir>/config.example.qfq.ini* to
  *<Documentroot>/typo3conf/config.qfq.ini* and configure the necessary values: `config.qfq.ini`_
  The configuration file is outside the extension directory to not loose it during updates.
Carsten  Rose's avatar
Carsten Rose committed
150
* When the QFQ Extension is called the first time on the Typo3 Frontend, the file *<ext_dir>/qfq/sql/formEditor.sql* will
151
  played and fills the database with the *Form editor* records. This also happens automatically after each software update of QFQ.
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
* Configure Typoscript to include Bootstrap, jQuery, QFQ javascript and CSS files.

::

	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 {
		file1 = typo3conf/ext/qfq/Resources/Public/JavaScript/jquery.min.js
		file2 = typo3conf/ext/qfq/Resources/Public/JavaScript/bootstrap.min.js
		file3 = typo3conf/ext/qfq/Resources/Public/JavaScript/validator.min.js
		file4 = typo3conf/ext/qfq/Resources/Public/JavaScript/jqx-all.js
		file5 = typo3conf/ext/qfq/Resources/Public/JavaScript/globalize.js
		file6 = typo3conf/ext/qfq/Resources/Public/JavaScript/tinymce.min.js
		file7 = typo3conf/ext/qfq/Resources/Public/JavaScript/EventEmitter.min.js
		file8 = typo3conf/ext/qfq/Resources/Public/JavaScript/qfq.min.js
	}

181
.. _form-editor:
182
183
184

FormEditor
----------
185

186
187
188
189
190
191
Setup a *report* to manage all *forms*:

* Create a Typo3 page.
* Set the 'URL Alias' to `form` (default) or the individual defined value in parameter EDIT_FORM_PAGE (config.qfq.ini).
* Insert a content record of type *qfq*.
* In the bodytext insert the following code:
192
193
194
195

::

	# If there is a form given by SIP: show
196
	form={{form:SE}}
197
198
199
200

	10 {
		# List of Forms: Do not show this list of forms if there is a form given by SIP.
		# Table header.
201
		sql = SELECT CONCAT('{{pageId:T}}&form=form&') as _Pagen, '#', 'Name', 'Title', 'Table', '' FROM (SELECT 1) AS fake WHERE  '{{form:SE}}'=''
202
		head = <table class="table table-hover qfq-table-50">
203
204
205
206
207
208
209
210
		tail = </table>
		rbeg = <thead><tr>
		rend = </tr></thead>
		fbeg = <th>
		fend = </th>

		10 {
			# All forms
211
			sql = SELECT CONCAT('{{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
212
213
214
215
216
217
218
219
220
221
222
223
			rbeg = <tr>
			rend = </tr>
			fbeg = <td>
			fend = </td>
		}
	}

.. _config-qfq-ini:

config.qfq.ini
--------------

224
225
226
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
| Keyword                     | Example                                         | Description                                                                |
+=============================+=================================================+============================================================================+
227
| DB_<n>_USER                 | DB_1_USER=qfqUser                               | Credentials configured in MySQL                                            |
228
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
229
| DB_<n>_PASSWORD             | DB_1_PASSWORD=1234567890                        | Credentials configured in MySQL                                            |
230
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
231
| DB_<n>_SERVER               | DB_1_SERVER=localhost                           | Hostname of MySQL Server                                                   |
232
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
233
| DB_<n>_NAME                 | DB_1_NAME=qfq_db                                | Database name                                                              |
234
235
236
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
| DB_INIT                     | DB_INIT=set names utf8                          | Global init for using the database.                                        |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
237
238
239
240
| DB_INDEX_DATA               | DB_INDEX_DATA = 1                               | Optional. Default: 1.                                                      |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
| DB_INDEX_QFQ                | DB_INDEX_QFQ = 1                                | Optional. Default: 1.                                                      |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
241
242
| SQL_LOG                     | SQL_LOG=sql.log                                 | Filename to log SQL commands: relative to <ext_dir> or absolute.           |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
243
244
| SQL_LOG_MODE                | SQL_LOG_MODE=modify                             | *all*: every statement will be logged - this might a lot.                  |
|                             |                                                 | *modify*: log only statements who change data.                             |
245
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
246
247
| SHOW_DEBUG_INFO             | SHOW_DEBUG_INFO=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.                    |
248
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
249
250
| REDIRECT_ALL_MAIL_TO        | REDIRECT_ALL_MAIL_TO=john@doe.com               | If set, redirect all QFQ generated mails (Form, Report) to the specified.  |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
Carsten  Rose's avatar
Carsten Rose committed
251
| CSS_LINK_CLASS_INTERNAL     | CSS_LINK_CLASS_INTERNAL=internal                | CSS class name of links which points to internal tagets                    |
252
253
254
255
256
257
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
| CSS_LINK_CLASS_EXTERNAL     | CSS_LINK_CLASS_EXTERNAL=external                | CSS class name of links which points to internal tagets                    |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
| CSS_CLASS_QFQ_CONTAINER     |CSS_CLASS_QFQ_CONTAINER=container                | QFQ with own Bootstrap: 'container'.                                       |
|                             |                                                 | QFQ already nested in Bootstrap of mainpage: <empty>                       |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
258
259
| CSS_CLASS_QFQ_FORM          | CSS_CLASS_QFQ_FORM=qfq-color-base               | Wrap around QFQ 'Form'                                                     |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
| CSS_CLASS_QFQ_FORM_PILL     |CSS_CLASS_QFQ_FORM_PILL=qfq-color-grey-1         | Wrap around title bar for pills: CSS Class, typically a background color   |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
| CSS_CLASS_QFQ_FORM_BODY     |CSS_CLASS_QFQ_FORM_BODY=qfq-color-grey-2         | Wrap around formelements: CSS Class, typically a background color          |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
| DATE_FORMAT                 | DATE_FORMAT= yyyy-mm-dd                         | Possible options: yyyy-mm-dd, dd.mm.yyyy                                   |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
| FORM_DATA_PATTERN_ERROR     |FORM_DATA_PATTERN_ERROR=please check pa.         | Customizable error message used in validator.js. 'pattern' violation       |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
| FORM_DATA_REQUIRED_ERROR    |FORM_DATA_REQUIRED_ERROR=missing value           | Customizable error message used in validator.js. 'required' fields         |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
| FORM_DATA_MATCH_ERROR       |FORM_DATA_MATCH_ERROR=type error                 | Customizable error message used in validator.js. 'match' retype mismatch   |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
| FORM_DATA_ERROR             |FORM_DATA_ERROR=generic error                    | Customizable error message used in validator.js. 'no specific' given       |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
| FORM_BS_COLUMNS             | FORM_BS_COLUMNS=12                              | The whole form will be wrapped in 'col-md-??'. Default is 12 for 100%      |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
| FORM_BS_LABEL_COLUMNS       | FORM_BS_LABEL_COLUMNS = 3                       | Default number of BS columns for the 'label'-column                        |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
| FORM_BS_INPUT_COLUMNS       | FORM_BS_INPUT_COLUMNS = 6                       | Default number of BS columns for the 'input'-column                        |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
| FORM_BS_NOTE_COLUMNS        | FORM_BS_NOTE_COLUMNS = 3                        | Default number of BS columns for the 'note'-column                         |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
Carsten  Rose's avatar
Carsten Rose committed
282
| FORM_BUTTON_ON_CHANGE_CLASS | FORM_BUTTON_ON_CHANGE_CLASS=alert-info btn-info | Color for save button after modification                                   |
283
284
285
286
287
288
289
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
| BASE_URL_PRINT              | BASE_URL_PRINT=http://example.com               | URL where wkhtmltopdf will fetch the HTML (no parameter, those comes later)|
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
| WKHTMLTOPDF                 | WKHTMLTOPDF=/usr/bin/wkhtmltopdf                | Binary where to find wkhtmltopdf.                                          |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
| EDIT_FORM_PAGE              | EDIT_FORM_PAGE = form                           | T3 Pagealias to edit a form.                                               |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
290
291
| 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   |
+-----------------------------+-------------------------------------------------+ crendentials is supported.                                                 |
292
293
| LDAP_1_PASSWORD             | LDAP_1_PASSWORD=mySecurePassword                |                                                                            |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
294
295
| ESCAPE_TYPE_DEFAULT         | ESCAPE_TYPE_DEFAULT=s                           | All variables `{{...}}` get this escape class by default.                  |
|                             |                                                 | See `variable-escape`_.                                                    |
296
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
297
298
299
300
301
302
| SECURITY_VARS_HONEYPOT      | SECURITY_VARS_HONEYPOT = email,username,password| If empty: no check. All named variables will rendered as INPUT elements    |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
| SECURITY_ATTACK_DELAY       | SECURITY_ATTACK_DELAY = 5                       | If an attack is detected, sleep 'x' seconds and exit PHP process           |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
| SECURITY_SHOW_MESSAGE       | SECURITY_SHOW_MESSAGE = true                    | If an attack is detected, show a message                                   |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
Carsten  Rose's avatar
Carsten Rose committed
303
304
| SECURITY_GET_MAX_LENGTH     | SECURITY_GET_MAX_LENGTH = 50                    | GET vars longer than 'x' chars triggers an `attack-recognized`.            |
|                             |                                                 | `ExceptionMaxLength`_                                                      |
305
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
306
| GFX_EXTRA_BUTTON_INFO_INLINE| <img src="info.png">                            | Image for `extraButtonInfo`_ (inline)                                      |
307
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
308
| GFX_EXTRA_BUTTON_INFO_BELOW | <img src="info.png">                            | Image for `extraButtonInfo`_ (below)                                       |
309
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
310
311
312
| EXTRA_BUTTON_INFO_POSITION  | SYSTEM_EXTRA_BUTTON_INFO_POSITION=below         | 'auto' (default) or 'below'. See `extraButtonInfo`_                        |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
| EXTRA_BUTTON_INFO_CLASS     | SYSTEM_EXTRA_BUTTON_INFO_CLASS=pull-right       | '' (default) or 'pull-right'. See `extraButtonInfo`_                       |
313
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
314
| SAVE_BUTTON_TEXT            | SAVE_BUTTON_TEXT =                              | Default text on the form save button. Typically none.                      |
315
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
316
| SAVE_BUTTON_TOOLTIP         | SAVE_BUTTON_TOOLTIP = save                      | Default tooltip on the form save button.                                   |
317
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
318
| SAVE_BUTTON_CLASS           | SAVE_BUTTON_CLASS = btn btn-default navbar-btn  | Default Bootstrap CSS class for buttons on top of the form                 |
319
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
320
321
322
| SAVE_BUTTON_GLYPH_ICON      | SAVE_BUTTON_GLYPH_ICON = glyphicon-ok           | Default Icon for the form save button                                      |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
| CLOSE_BUTTON_TEXT           | CLOSE_BUTTON_TEXT =                             | Default text on the form close button. Typically none.                     |
323
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
324
| CLOSE_BUTTON_TOOLTIP        | CLOSE_BUTTON_TOOLTIP = close                    | Default tooltip on the form close button.                                  |
325
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
326
| CLOSE_BUTTON_CLASS          | CLOSE_BUTTON_CLASS = btn btn-default navbar-btn | Default Bootstrap CSS class for buttons on top of the form                 |
327
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
328
329
330
| CLOSE_BUTTON_GLYPH_ICON     | CLOSE_BUTTON_GLYPH_ICON = glyphicon-remove      | Default Icon for the form close button                                     |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
| DELETE_BUTTON_TEXT          | DELETE_BUTTON_TEXT =                            | Default text on the form delete button. Typically none.                    |
331
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
332
| DELETE_BUTTON_TOOLTIP       | DELETE_BUTTON_TOOLTIP = delete                  | Default tooltip on the form delete button.                                 |
333
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
334
| DELETE_BUTTON_CLASS         | DELETE_BUTTON_CLASS = btn btn-default navbar-btn| Default Bootstrap CSS class for buttons on top of the form                 |
335
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
336
337
338
| DELETE_BUTTON_GLYPH_ICON    | DELETE_BUTTON_GLYPH_ICON = glyphicon-trash      | Default Icon for the form delete button                                    |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
| NEW_BUTTON_TEXT             | NEW_BUTTON_TEXT =                               | Default text on the form new button. Typically none.                       |
339
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
340
| NEW_BUTTON_TOOLTIP          | NEW_BUTTON_TOOLTIP = new                        | Default tooltip on the form new button.                                    |
341
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
342
| NEW_BUTTON_CLASS            | NEW_BUTTON_CLASS = btn btn-default navbar-btn   | Default Bootstrap CSS class for buttons on top of the form                 |
343
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
344
345
| NEW_BUTTON_GLYPH_ICON       | NEW_BUTTON_GLYPH_ICON = glyphicon-plus          | Default Icon for the form new button                                       |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
346
347
348
349
350
| DB_UPDATE                   | DB_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.                                           |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
Carsten  Rose's avatar
Carsten Rose committed
351
352
| DIRTY_RECORD_TIMEOUT_SECONDS| DIRTY_RECORD_TIMEOUT_SECONDS = 900              | Timeout for record locking. After this time, a record will be replaced     |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
353
354
| DOCUMENTATION_QFQ           | DOCUMENTATION_QFQ=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    |
355
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
Carsten  Rose's avatar
Carsten Rose committed
356
| VAR_ADD_BY_SQL              | VAR_ADD_BY_SQL = {{!SELECT s.id AS ...          | Specific values read from the database to fill the system store during QFQ |
Carsten  Rose's avatar
Carsten Rose committed
357
|                             |                                                 | load. See `VariablesAddBySql`_ for a usecase.                              |
358
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
359
360
361
362
363
364
365
366
367
368
| FORM_LANGUAGE_A_ID          | FORM_LANGUAGE_A__ID = 1                         | In Typo3 configured pageLanguage id. The number after the 'L' parameter.   |
| FORM_LANGUAGE_B_ID          |                                                 |                                                                            |
| FORM_LANGUAGE_C_ID          |                                                 |                                                                            |
| FORM_LANGUAGE_D_ID          |                                                 |                                                                            |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
| FORM_LANGUAGE_A_LABEL       | FORM_LANGUAGE_A_LABEL = english                 | Label shown in *Form editor*, on the 'basic' tab.                          |
| FORM_LANGUAGE_B_LABEL       |                                                 |                                                                            |
| FORM_LANGUAGE_C_LABEL       |                                                 |                                                                            |
| FORM_LANGUAGE_D_LABEL       |                                                 |                                                                            |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
369

370
371
372
373
374
Example: *typo3conf/config.qfq.ini*

::

	; To get internal default values, inactivate the option by commenting (= ';') it.
375
376
377
378
	DB_1_USER = qfqUser
	DB_1_SERVER = localhost
	DB_1_PASSWORD = 12345678
	DB_1_NAME = qfq_db
379
	DB_INIT = set names utf8
380
381
	; DB_INDEX_DATA = 1
   ; DB_INDEX_QFQ = 1
382
383
384
385
	; SQL_LOG = sql.log
	; SQL_LOG_MODE = modify
	; SHOW_DEBUG_INFO = auto
	; REDIRECT_ALL_MAIL_TO = john.doe@example.com
386
387
	CSS_LINK_CLASS_INTERNAL = internal
	CSS_LINK_CLASS_EXT = external
388
389
	; CSS_CLASS_QFQ_CONTAINER =
	; CSS_CLASS_QFQ_FORM =
390
391
	CSS_CLASS_QFQ_FORM_PILL = qfq-color-grey-1
	CSS_CLASS_QFQ_FORM_BODY = qfq-color-grey-2
392
	; DATE_FORMAT= yyyy-mm-dd
393

394
	; TECHNICAL CONTACT = john@doe.com
395

396
397
398
399
	; FORM_DATA_PATTERN_ERROR =
	; FORM_DATA_REQUIRED_ERROR =
	; FORM_DATA_MATCH_ERROR =
	; FORM_DATA_ERROR =
400

401
402
403
404
	; FORM_BS_COLUMNS = 12
	; FORM_BS_LABEL_COLUMNS = 3
	; FORM_BS_INPUT_COLUMNS = 6
	; FORM_BS_NOTE_COLUMNS = 3
405

406
	BASE_URL_PRINT=http://example.com/
407
	WKHTMLTOPDF=/usr/bin/wkhtmltopdf
408

409
	; EDIT_FORM_PAGE = form
410

411
412
	; LDAP_1_RDN='ou=Admin,dc=example,dc=com'
	; LDAP_1_PASSWORD=mySecurePassword
413

414
	; ESCAPE_TYPE_DEFAULT=m
415
416
417
418
	; SECURITY_VARS_HONEYPOT=email,username,password
	; SECURITY_ATTACK_DELAY=5
	; SECURITY_SHOW_MESSAGE=true
	; SECURITY_GET_MAX_LENGTH=50
419

420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
	;SAVE_BUTTON_TEXT =
	;SAVE_BUTTON_TOOLTIP = save
	;SAVE_BUTTON_CLASS = btn btn-default navbar-btn
	;SAVE_BUTTON_GLYPH_ICON = glyphicon-ok

	;CLOSE_BUTTON_TEXT =
	;CLOSE_BUTTON_TOOLTIP = close
	;CLOSE_BUTTON_CLASS = btn btn-default navbar-btn
	;CLOSE_BUTTON_GLYPH_ICON = glyphicon-remove

	;DELETE_BUTTON_TEXT =
	;DELETE_BUTTON_TOOLTIP = delete
	;DELETE_BUTTON_CLASS = btn btn-default navbar-btn
	;DELETE_BUTTON_GLYPH_ICON = glyphicon-trash

	;NEW_BUTTON_TEXT =
	;NEW_BUTTON_TOOLTIP = new
	;NEW_BUTTON_CLASS = btn btn-default navbar-btn
	;NEW_BUTTON_GLYPH_ICON = glyphicon-plus

440
	; auto | always | never
Carsten  Rose's avatar
Carsten Rose committed
441
	;DB_UPDATE = auto
Carsten  Rose's avatar
Carsten Rose committed
442
443

	;RECORD_LOCK_TIMEOUT_SECONDS = 900
444

445
	; Local Documentation (doc fits to installed version):  typo3conf/ext/qfq/Documentation/html/Manual.html
446
447
	;DOCUMENTATION_QFQ = https://docs.typo3.org/typo3cms/drafts/github/T3DocumentationStarter/Public-Info-053/Manual.html

448
	;VAR_ADD_BY_SQL = 'SELECT s.id AS _periodId FROM Period AS s WHERE s.start<=NOW() ORDER BY s.start DESC LIMIT 1'
449

450
451
	;FORM_LANGUAGE_A_ID = 1
	;FORM_LANGUAGE_A_LABEL = english
452

453
454
455
	;GFX_EXTRA_BUTTON_INFO_INLINE = <img src='info.png'>
	;GFX_EXTRA_BUTTON_INFO_BELOW = <img src='info.png'>
	;EXTRA_BUTTON_INFO_POSITION = auto | below
456
	;EXTRA_BUTTON_INFO_CLASS = pull-right
457

458
459
460
461
.. _`CustomVariables`:

Custom variables
^^^^^^^^^^^^^^^^
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476

It's also possible to setup custom variables in `config.qfq.ini`.

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

 * `config.qfq.in`::

		ADMINISTRATIVE_CONTACT = john@doe.com
		ADMINISTRATIVE_ADDRESS = John Doe, Hollywood Blvd. 1, L.A.
		ADMINISTRATIVE_NAME = John Doe

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

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

477
478
479
480
481
482
483
484
485
486
487
488
.. _`VariablesAddBySql`:

Variables add by SQL
^^^^^^^^^^^^^^^^^^^^

A specified SELECT statement in `config.qfq.ini`_ in variable `VAR_ADD_BY_SQL` fill be fired after filling the SYSTEM STORE.
The query should have 0 (nothing happens) or 1 row. The column names and column values will be added as variables to the SYSTEM_STORE.
Existing variables will be overwritten. Be carefull not to overwrite needed values.
 
This option is usefull to make generic custom values, saved in the database, accessible to all QFQ Report and Forms.
Access such variables as usual via `{{<varname>:Y}}`.

489
.. _`periodId`:
490
491
492
493
494
495
496

periodId
''''''''

This is

* a usecase, implemented via `VariablesAddBySql`_,
497
* a way to access `Period.id` with respect to the current period (the period itself is custom defined).
498
499
500
501
502

After a full QFQ installation, three things are prepared:

* a table `Period` (extend / change it to your needs, fill them with your periods),
* one sample record in table `Period`,
503
* in `config.qfq.ini`_ the default definition of `VAR_ADD_BY_SQL` will set the variable `periodId` during QFQ load.
504
505
506
507
508
509
510
511

Websites, delivering semester data, schoolyears schedules, or any other type or periods, often need an index to the
*current* period. One way is a) to mark the current period and b) to change the marker every time when the next period
becomes current.
The QFQ approach works without a marker and without manual intervention: the whished index will be computed during QFQ load.

In `config.qfq.ini`: ::

512
	VAR_ADD_BY_SQL = 'SELECT id AS periodId FROM Period WHERE start<=NOW() ORDER BY start DESC LIMIT 1'
513
514
515
516
517
518
519
520
521
522
523
524
525

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`:
526
527
528
529
530
531
532
533
534
535
536
537

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.



538
539
540
541
542
543
.. _`ExceptionMaxLength`:

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

If it is necessary to use a GET variable which exceeds SECURITY_GET_MAX_LENGTH limit, name the variable with '_<num>' at
544
the end. E.g. `my_long_variable_130`. Such a variable has an allowed length of 130 chars. Access the variable as
545
546
547
usual with the variable name: `{{my_long_variable_130:C:...}}`.


548
549
550
551
552
.. _local-documentation:

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

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

555
556
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
557
558
server). For a development server instead, deactivate the forbid rule of 'documentation'. In `.htaccess` (snippet from
Typo3 7.6 _.htaccess): ::
559

560
561
  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]
562
563
564
565
566
567

.. _concept:

Concept
=======

568
569
570
571
572
SIPs
----

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

573
The SIPs (=Server Id Pairs) are uniq timestamps, created/registered on the fly for a specific browser session (=user). Every SIP is
574
575
576
577
578
579
580
581
582
583
584
585
586
587
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.
588
589
590
591
592

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

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

594
595
596
597
598
599
600
* 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
601
602
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.
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617

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

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

The title of the QFQ content element will not be rendered. It's only visible in the backend for orientation.

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

 +-------------------+---------------------------------------------------------------------------------+
 | Name              | Explanation                                                                     |
 +===================+=================================================================================+
 | form              | Formname defined in ttcontent record bodytext                                   |
618
619
620
 |                   | - Fix. E.g.: **form = person**                                                  |
 |                   | - by SIP: **form = {{form}}**                                                   |
 |                   | - by SQL: **form = {{SELECT c.form FROM conference AS c WHERE c.id={{a:C}} }}** |
621
622
 +-------------------+---------------------------------------------------------------------------------+
 | r                 | <record id> The form will load the record with the specified id                 |
623
624
 |                   | - Variants: **r = 123**, by SQL: **r = {{SELECT ...}}**                         |
 |                   | - If not specified, the default is '0'                                          |
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
 +-------------------+---------------------------------------------------------------------------------+
 | <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)                                             |
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.head      | Start token for whole <level>                                                   |
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.tail      | End token for whole <level>                                                     |
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.rbeg      | Start token for row.                                                            |
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.rbgd      | Alternating (per row) token                                                     |
 +-------------------+---------------------------------------------------------------------------------+
 | <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                                                                       |
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.althead   | If <level>.sql is empty, these token will be rendered                           |
 +-------------------+---------------------------------------------------------------------------------+
652
653
654
655
656
 | debugShowBodyText | If='1' and config.qfq.ini:*SHOW_DEBUG_INFO = yes*, shows a tooltip with bodytext|
 +-------------------+---------------------------------------------------------------------------------+
 | sqlLog            | Overwrites config.qfq.ini: `SQL_LOG`_ . Only affects `Report`, not `Form`.      |
 +-------------------+---------------------------------------------------------------------------------+
 | sqlLogMode        | Overwrites config.qfq.ini: `SQL_LOG_MODE`_ . Only affects `Report`, not `Form`. |
657
658
659
660
661
662
663
 +-------------------+---------------------------------------------------------------------------------+

.. _debug:

Debug
^^^^^

664
665
666
667
668
669
670
671
672
673
674
File: `config.qfq.ini`_

.. _SQL_LOG:

* *SQL_LOG*

  * Filename where to log SQL queries and statistical data.
  * File is relative to the extension directory or absolute (starting with '/').
  * 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.
675

676
677
678
679
680
681
682
683
684
685
686
687
688
689

.. _SQL_LOG_MODE:

* *SQL_LOG_MODE = all|modify|error|none*

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

* *SHOW_DEBUG_INFO = [yes|no|auto],[download]*

  If active, displays additional information in the Frontend (FE). This is typically helpful during development.
690
691
692
693
694
695

  * *yes*:

    * Form:

      * For every internal link/button, show tooltips with decoded SIP on mouseover.
696
      * Shows an 'Edit form'-button (wrench symbol) on a form. The link points to the T3 page with the :ref:`form-editor`.
697
698
699
700
701
702
703
704
705
706
707
708

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

    * *SHOW_DEBUG_INFO = yes*  (BE session exist)
    * *SHOW_DEBUG_INFO = no*   (no BE session)

709
710
711
  * *download*:

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

714
715
716
717
718
719
720
721
722
723
724
725
.. _REDIRECT_ALL_MAIL_TO:

* *REDIRECT_ALL_MAIL_TO=john@doe.com*

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

  * The setting will:

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

.. _variables:

729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
Databases
---------

A Typo3 / QFQ Installation needs at least two databases. One for the Typo3 installation and one for QFQ.

QFQ itself can be separated in 'QFQ system' and 'QFQ data' databases, if necessary (than at least three databases are needed).
Furthermore a `Form` can operate on any additional database, specified per `Form`.parameter.dbIndex and configured via `config.qfq.ini`_.

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

In `config.qfq.ini`_ mutliple database credentials can be prepared. Mandatory is at least one credential setup like
`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.

Often the `DB_1_xxx` is identically to the used Typo3 database credentials.

If not explicit specified, 'QFQ system' and 'QFQ database' will use the same database with the same credentials (setup 'A').

To define separate 'QFQ data' and 'QFQ system', in `config.qfq.ini`_ define  `DB_1_USER`, ... (e.g. 'QFQ data') and `DB_2_USER`,
... (e.g. 'QFQ system') and specify the assignment::

	DB_INDEX_DATA = 1
	DB_INDEX_QFQ = 2

To let a form operate (show, load and save) on a different database, use `Form.parameter.dbIndexData` (see `form-parameter`_).

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

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

780
781
Variable
========
782

783
784
Most elements of a Form, FormElement or Report might contain (QFQ) variables. Such variables are surrounded by
double curly braces. Three different types of functionality are provided. Access to:
785

786
787
788
* `store-variables`_
* `sql-variables`_
* `column-variables`_
789

790
Some examples, including nesting::
791

792
793
794
795
796
  # Store
  #---------------------------------------------
  {{r}}
  {{index:FS}}
  {{name:FS:alnumx:s}}
797

798
799
800
  # SQL
  #---------------------------------------------
  {{SELECT name FROM person WHERE id=1234}}
801

802
803
804
805
  # Columns
  #---------------------------------------------
  {{10.pId}}
  {{10.20.pId}}
806

807
808
809
810
811
  # 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
812
813


814
Leading and trailing spaces inside curly braces are removed.
815

816
817
  * *{{ SELECT "Hello World"   }}* becomes *{{SELECT "Hello World"}}*
  * *{{ varname   }}* becomes *{{varname}}*
818

819
820
Types
-----
821

822
.. _`store-variables`:
823

824
825
Store variables
^^^^^^^^^^^^^^^
826

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

829
* Example::
830

831
832
833
834
  {{pId}}
  {{pId:FSE}}
  {{pId:FSE:digit}}
  {{name:FSE:alnumx:m}}
835
  {{name:FSE:alnumx:m:John Doe}}
836

837
838
839
* 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.
840
841
* 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.
842
* If anywhere along the line an empty string is found, this **is** a value: therefore, the search will stop.
843

844
See also:
845

846
847
848
 * `store`_
 * `variable-escape`_
 * `sanitize-class`_
849

850

851
.. _`sql-variables`:
852

853
854
SQL variables
^^^^^^^^^^^^^
855

856
857
858
* The detection of an SQL command is case *insensitive*.
* Leading  whitespace will be skipped.
* The following commands are interpreted as SQL commands:
859

860
861
862
  * SELECT
  * INSERT, UPDATE, DELETE, REPLACE, TRUNCATE
  * SHOW, DESCRIBE, EXPLAIN, SET
863

864
865
866
867
* A SQL Statement might contain parameters, including additional SQL statements. Inner SQL queries will be executed first.
* 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.
* A resultset of a SQL statement will be imploded over all: concat all columns of a row, concat all rows - there is no glue string.
868

869
* Example::
870

871
  {{SELECT id, name FROM Person}}
Carsten  Rose's avatar
Carsten Rose committed
872
873
  {{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}} }} }}
874

875
* Special case for `SELECT` input fields and FormElement.type=action `sqlValidate`. To deliver a result array specify an '!' before the SELECT: ::
876

877
   {{!SELECT ...}}
878

879

880
.. _`column-variables`:
881

882
883
884
885
886
Column variables
^^^^^^^^^^^^^^^^

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

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

889
890
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.
891
892
893

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

894
895
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
896
897
898
specific locations in the text will be (automatically by QFQ) replaced by values from other sources.

.. _`sanitize-class`:
899
900

Sanitize class
901
902
903
904
905
906
--------------

* If a value violates a parameter sanitize class, the value becomes an empty string.
* Per store there is a default if sanitizing applies and if yes, which class.

  * Store *C* (Client=Browser) and store *F* (Form) will be sanitized with 'digit'.
907

908
* All `predefined-variable-names`_ have a specific default sanitize class. For these variables, it's not necessary
909
  to specify a sanitize class.
910
* All other variables (Store: C, F) get by default the sanitize class defined in the corresponding form. If not defined,
911
912
  the default class is 'digit'.
* A default sanitize class can be overwritten by individual definition: *{{a:C:all}}*
913
914
915
* If there is a sanitized class specified, it applies to all given stores.

For QFQ variables and FormElements:
916
917
918
919

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


Only in FormElement:

934
935
936
937
938
939
940
941
942
943
+------------------+------+-------+-----------------------------------------------------------------------------------------+
| **email**        | Form | Query | [a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}                                          |
+------------------+------+-------+-----------------------------------------------------------------------------------------+
| **min|max**      | Form |       | Compares the value against an lower and upper limit (numeric or string).                |
+------------------+------+-------+-----------------------------------------------------------------------------------------+
| **min|max date** | Form |       | Compares the value against an lower and upper date or datetime.                         |
+------------------+------+-------+-----------------------------------------------------------------------------------------+
| **pattern**      | Form |       | Compares the value against a regexp.                                                    |
+------------------+------+-------+-----------------------------------------------------------------------------------------+

944
945
946
947
948
949
950
951
952
953
954
955
956
957
.. _`variable-escape`:

Escape
------

Variables used in SQL Statements might cause trouble by using: NUL (ASCII 0), \\n, \\r, \\, ', ", and Control-Z.

To protect the web application the following `escape` types are available:

	* 'm' - `real_escape_string() <http://php.net/manual/en/mysqli.real-escape-string.php>`_ (m = mysql)
	* 'l' - LDAP search filter values will be escaped: `ldap-escape() <http://php.net/manual/en/function.ldap-escape.php>`_ (LDAP_ESCAPE_FILTER).
	* 'L' - LDAP DN values will be escaped. `ldap-escape() <http://php.net/manual/en/function.ldap-escape.php>`_ (LDAP_ESCAPE_DN).
	* 's' - single ticks will be escaped. str_replace() of ' against \\'.
	* 'd' - double ticks will be escaped: str_replace() of " against \\".
958
959
	* 'c' - config - the escape type configured in `config.qfq.ini`_.
	* ''  - the escape type configured in `config.qfq.ini`_.
960
961
962
963
964
965
966
967
	* '-' - no escaping.

* The `escape` type is defined by the fourth parameter of the variable. E.g.: `{{name:FE:alnumx:m}}` (m = mysql).
* It's possible to combine different `escape` types, they will be processed in the order given. E.g. `{{name:FE:alnumx:Ls}}` (L, s).
* Escaping is typically necessary for SQL or LDAP queries.
* Be careful when escaping nested variables. Best is to escape **only** the most outer variable.
* In `config.qfq.ini`_ a global `ESCAPE_TYPE_DEFAULT` can be defined. The configured escape type applies to all substituted
  variables, who *do not* contain a *specific* escape type.
968
* Additionally a `defaultEscapeType` can be defined per `Form` (separate field in the *Form editor*). This overwrites the
969
970
971
  global definition of `config.qfq.ini`. By default, every `Form.defaultEscapeType` = 'c' (=config), which means the setting
  in `config.qfq.ini`_.
* To suppress a default escape type, define the `escape type` = '-' on the specific variable. E.g.: `{{name:FE:alnumx:-}}`.
972

973
974
975
976
977
Security
========

All values passed to QFQ will be:

978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
* Checked against max. length and allowed content, on the client and on the server side. On the server side, the check
  happens before any further processing. The 'length' and 'allowed' content is specified per `FormElement`. 'alnumx' is the
  default allowed content for those. Violating the rules will stop the 'save record' process (Form) or result in an empty value (Report).

* Only elements defined in the `Form` definition or requested by `Report` will be processed.

* UTF8 normalized (normalizer::normalize) to unify different ways of composing characters. It's more a database interest
  to work with unified data.

SQL statements are typically fired as `prepared statements` with separated variables.
Further *custom* SQL statements will be defined by the webmaster - those do not use `prepared statements` and might be
affected by SQL injection. To prevent SQL injection, every variable can be escaped with `mysqli::real_escape_string` by
defining the `escape` modifier `m`.

**QFQ notice**:

994
* Variables passed by the client (=Browser) are untrusted and use the default sanitize class 'digit' (if nothing else is
995
996
  specified). If alpha characters are submitted, the content violates `digit` and becomes therefore empty - there is no
  error message. Best is to always use SIP or digits.
997
998
999
1000

Get Parameter
-------------