Manual.rst 318 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
25
26
27
.. _general:

General
=======

* Project homepage: https://git.math.uzh.ch/typo3/qfq
* Latest relases: https://w3.math.uzh.ch/qfq/

28
29
30
31
32
33

.. _installation:

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

34
35
36
37
38
39
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`.

40
41
.. _`preparation`:

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

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

60
61
Preparation for Ubuntu 14.04::

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

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

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

72
.. _wkhtml:
73

74
75
wkhtmltopdf
^^^^^^^^^^^
76

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

80
* The Ubuntu package `wkhtmltopdf` needs a running Xserver - this does not work on a headless webserver. Best is to
81
  install the QT version from the named website above.
82

83
In `config-qfq-ini`_ specify the:
84

85
86
87
88
89
90
91
92
* installed `wkhtmltopdf` binary:

  * `WKHTMLTOPDF = /.../wkhtmltopdf`

* the site base URL:

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

93

94
95
**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.
96
97

Configure via Typo3 Installtool `All configuration > $TYPO3_CONF_VARS['FE']`: ::
98
99
100

   [FE][lockIP] = 0

101
102
103
104
105
**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.

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

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

119
120
121
122
123
124
125
126
127
128
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 {
129
		wrap = <a href="typo3conf/ext/qfq/qfq/api/print.php?id=|&type=2"><span class="glyphicon glyphicon-print" aria-hidden="true"></span> Printview</a>
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
		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
147
148
* When the QFQ Extension is called the first time on the Typo3 Frontend, the file *<ext_dir>/qfq/sql/formEditor.sql* will
  played and fills the database with the *FormEditor* records. This also happens automatically after each software update of QFQ.
149
150
151
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
* 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
	}

178
.. _form-editor:
179
180
181

FormEditor
----------
182

183
184
185
186
187
188
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:
189
190
191
192

::

	# If there is a form given by SIP: show
193
	form={{form:SE}}
194
195
196
197

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

		10 {
			# All forms
208
			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
209
210
211
212
213
214
215
216
217
218
219
220
			rbeg = <tr>
			rend = </tr>
			fbeg = <td>
			fend = </td>
		}
	}

.. _config-qfq-ini:

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

221
222
223
224
225
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
| Keyword                     | Example                                         | Description                                                                |
+=============================+=================================================+============================================================================+
| DB_USER                     | DB_USER=qfqUser                                 | Credentials configured in MySQL                                            |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
226
| DB_PASSWORD                 | DB_PASSWORD=1234567890                          | Credentials configured in MySQL                                            |
227
228
229
230
231
232
233
234
235
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
| DB_SERVER                   | DB_SERVER=localhost                             | Hostname of MySQL Server                                                   |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
| DB_NAME                     | DB_NAME=qfq_db                                  | Database name                                                              |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
| DB_INIT                     | DB_INIT=set names utf8                          | Global init for using the database.                                        |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
| SQL_LOG                     | SQL_LOG=sql.log                                 | Filename to log SQL commands: relative to <ext_dir> or absolute.           |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
236
237
| SQL_LOG_MODE                | SQL_LOG_MODE=modify                             | *all*: every statement will be logged - this might a lot.                  |
|                             |                                                 | *modify*: log only statements who change data.                             |
238
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
239
240
| 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.                    |
241
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
242
243
| REDIRECT_ALL_MAIL_TO        | REDIRECT_ALL_MAIL_TO=john@doe.com               | If set, redirect all QFQ generated mails (Form, Report) to the specified.  |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
244
245
246
247
248
249
250
| CSS_LINK_CLASS_INTERNA    L | CSS_LINK_CLASS_INTERNAL=internal                | CSS class name of links which points to internal tagets                    |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
| 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>                       |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
251
252
| CSS_CLASS_QFQ_FORM          | CSS_CLASS_QFQ_FORM=qfq-color-base               | Wrap around QFQ 'Form'                                                     |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
| 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
275
| FORM_BUTTON_ON_CHANGE_CLASS | FORM_BUTTON_ON_CHANGE_CLASS=alert-info btn-info | Color for save button after modification                                   |
276
277
278
279
280
281
282
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
| 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.                                               |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
283
284
| 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.                                                 |
285
286
| LDAP_1_PASSWORD             | LDAP_1_PASSWORD=mySecurePassword                |                                                                            |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
287
288
| ESCAPE_TYPE_DEFAULT         | ESCAPE_TYPE_DEFAULT=s                           | All variables `{{...}}` get this escape class by default.                  |
|                             |                                                 | See `variable-escape`_.                                                    |
289
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
290
291
292
293
294
295
| 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
296
297
| SECURITY_GET_MAX_LENGTH     | SECURITY_GET_MAX_LENGTH = 50                    | GET vars longer than 'x' chars triggers an `attack-recognized`.            |
|                             |                                                 | `ExceptionMaxLength`_                                                      |
298
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
299
300
301
302
|GFX_EXTRA_BUTTON_INFO_INLINE | <img src="info.png">                            | Image for `extraButtonInfo`_ (inline)                                      |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
|GFX_EXTRA_BUTTON_INFO_BELOW  | <img src="info.png">                            | Image for `extraButtonInfo`_ (below)                                       |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
303
| SAVE_BUTTON_TEXT            | SAVE_BUTTON_TEXT =                              | Default text on the form save button. Typically none.                      |
304
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
305
| SAVE_BUTTON_TOOLTIP         | SAVE_BUTTON_TOOLTIP = save                      | Default tooltip on the form save button.                                   |
306
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
307
| SAVE_BUTTON_CLASS           | SAVE_BUTTON_CLASS = btn btn-default navbar-btn  | Default Bootstrap CSS class for buttons on top of the form                 |
308
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
309
310
311
| 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.                     |
312
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
313
| CLOSE_BUTTON_TOOLTIP        | CLOSE_BUTTON_TOOLTIP = close                    | Default tooltip on the form close button.                                  |
314
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
315
| CLOSE_BUTTON_CLASS          | CLOSE_BUTTON_CLASS = btn btn-default navbar-btn | Default Bootstrap CSS class for buttons on top of the form                 |
316
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
317
318
319
| 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.                    |
320
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
321
| DELETE_BUTTON_TOOLTIP       | DELETE_BUTTON_TOOLTIP = delete                  | Default tooltip on the form delete button.                                 |
322
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
323
| DELETE_BUTTON_CLASS         | DELETE_BUTTON_CLASS = btn btn-default navbar-btn| Default Bootstrap CSS class for buttons on top of the form                 |
324
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
325
326
327
| 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.                       |
328
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
329
| NEW_BUTTON_TOOLTIP          | NEW_BUTTON_TOOLTIP = new                        | Default tooltip on the form new button.                                    |
330
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
331
| NEW_BUTTON_CLASS            | NEW_BUTTON_CLASS = btn btn-default navbar-btn   | Default Bootstrap CSS class for buttons on top of the form                 |
332
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
333
334
| NEW_BUTTON_GLYPH_ICON       | NEW_BUTTON_GLYPH_ICON = glyphicon-plus          | Default Icon for the form new button                                       |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
335
336
337
338
339
| 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
340
341
| DIRTY_RECORD_TIMEOUT_SECONDS| DIRTY_RECORD_TIMEOUT_SECONDS = 900              | Timeout for record locking. After this time, a record will be replaced     |
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
342
343
| 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    |
344
+-----------------------------+-------------------------------------------------+----------------------------------------------------------------------------+
345

346

347
348
349
350
351
352
353
354
355
356
Example: *typo3conf/config.qfq.ini*

::

	; To get internal default values, inactivate the option by commenting (= ';') it.
	DB_USER = qfqUser
	DB_SERVER = localhost
	DB_PASSWORD = 12345678
	DB_NAME = qfq_db
	DB_INIT = set names utf8
357
358
359
360
	; SQL_LOG = sql.log
	; SQL_LOG_MODE = modify
	; SHOW_DEBUG_INFO = auto
	; REDIRECT_ALL_MAIL_TO = john.doe@example.com
361
362
	CSS_LINK_CLASS_INTERNAL = internal
	CSS_LINK_CLASS_EXT = external
363
364
	; CSS_CLASS_QFQ_CONTAINER =
	; CSS_CLASS_QFQ_FORM =
365
366
	CSS_CLASS_QFQ_FORM_PILL = qfq-color-grey-1
	CSS_CLASS_QFQ_FORM_BODY = qfq-color-grey-2
367
	; DATE_FORMAT= yyyy-mm-dd
368

369
	; TECHNICAL CONTACT = john@doe.com
370

371
372
373
374
	; FORM_DATA_PATTERN_ERROR =
	; FORM_DATA_REQUIRED_ERROR =
	; FORM_DATA_MATCH_ERROR =
	; FORM_DATA_ERROR =
375

376
377
378
379
	; FORM_BS_COLUMNS = 12
	; FORM_BS_LABEL_COLUMNS = 3
	; FORM_BS_INPUT_COLUMNS = 6
	; FORM_BS_NOTE_COLUMNS = 3
380

381
	BASE_URL_PRINT=http://example.com/
382
	WKHTMLTOPDF=/usr/bin/wkhtmltopdf
383

384
	; EDIT_FORM_PAGE = form
385

386
387
	; LDAP_1_RDN='ou=Admin,dc=example,dc=com'
	; LDAP_1_PASSWORD=mySecurePassword
388

389
390
391
392
393
	; ESCAPE_TYPE_DEFAULT=s
	; SECURITY_VARS_HONEYPOT=email,username,password
	; SECURITY_ATTACK_DELAY=5
	; SECURITY_SHOW_MESSAGE=true
	; SECURITY_GET_MAX_LENGTH=50
394

395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
	;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

415
	; auto | always | never
Carsten  Rose's avatar
Carsten Rose committed
416
	;DB_UPDATE = auto
Carsten  Rose's avatar
Carsten Rose committed
417
418

	;RECORD_LOCK_TIMEOUT_SECONDS = 900
419

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

423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
..

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

439
440
441
442
443
444
445
446
447
448
449
450
451
..

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.



452
453
454
455
456
457
.. _`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
458
the end. E.g. `my_long_variable_130`. Such a variable has an allowed length of 130 chars. Access the variable as
459
460
461
usual with the variable name: `{{my_long_variable_130:C:...}}`.


462
463
464
465
466
.. _local-documentation:

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

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

469
470
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
471
472
server). For a development server instead, deactivate the forbid rule of 'documentation'. In `.htaccess` (snippet from
Typo3 7.6 _.htaccess): ::
473

474
475
  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]
476
477
478
479
480
481

.. _concept:

Concept
=======

482
483
484
485
486
SIPs
----

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

487
The SIPs (=Server Id Pairs) are uniq timestamps, created/registered on the fly for a specific browser session (=user). Every SIP is
488
489
490
491
492
493
494
495
496
497
498
499
500
501
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.
502
503
504
505
506

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

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

508
509
510
511
512
513
514
* 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
515
516
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.
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531

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                                   |
532
533
534
 |                   | - Fix. E.g.: **form = person**                                                  |
 |                   | - by SIP: **form = {{form}}**                                                   |
 |                   | - by SQL: **form = {{SELECT c.form FROM conference AS c WHERE c.id={{a:C}} }}** |
535
536
 +-------------------+---------------------------------------------------------------------------------+
 | r                 | <record id> The form will load the record with the specified id                 |
537
538
 |                   | - Variants: **r = 123**, by SQL: **r = {{SELECT ...}}**                         |
 |                   | - If not specified, the default is '0'                                          |
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
 +-------------------+---------------------------------------------------------------------------------+
 | <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                           |
 +-------------------+---------------------------------------------------------------------------------+
566
567
568
569
570
 | 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`. |
571
572
573
574
575
576
577
 +-------------------+---------------------------------------------------------------------------------+

.. _debug:

Debug
^^^^^

578
579
580
581
582
583
584
585
586
587
588
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.
589

590
591
592
593
594
595
596
597
598
599
600
601
602
603

.. _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.
604
605
606
607
608
609

  * *yes*:

    * Form:

      * For every internal link/button, show tooltips with decoded SIP on mouseover.
610
      * Shows an 'Edit form'-button (wrench symbol) on a form. The link points to the T3 page with the :ref:`form-editor`.
611
612
613
614
615
616
617
618
619
620
621
622

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

623
624
625
  * *download*:

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

628
629
630
631
632
633
634
635
636
637
638
639
.. _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.
640
641
642

.. _variables:

643
644
Variable
========
645

646
647
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:
648

649
650
651
* `store-variables`_
* `sql-variables`_
* `column-variables`_
652

653
Some examples, including nesting::
654

655
656
657
658
659
  # Store
  #---------------------------------------------
  {{r}}
  {{index:FS}}
  {{name:FS:alnumx:s}}
660

661
662
663
  # SQL
  #---------------------------------------------
  {{SELECT name FROM person WHERE id=1234}}
664

665
666
667
668
  # Columns
  #---------------------------------------------
  {{10.pId}}
  {{10.20.pId}}
669

670
671
672
673
674
  # 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
675
676


677
Leading and trailing spaces inside curly braces are removed.
678

679
680
  * *{{ SELECT "Hello World"   }}* becomes *{{SELECT "Hello World"}}*
  * *{{ varname   }}* becomes *{{varname}}*
681

682
683
Types
-----
684

685
.. _`store-variables`:
686

687
688
Store variables
^^^^^^^^^^^^^^^
689

690
Syntax:  *{{VarName[:<store / prio>[:<sanitize class>[:<escape>]]]}}*
691

692
* Example::
693

694
695
696
697
  {{pId}}
  {{pId:FSE}}
  {{pId:FSE:digit}}
  {{name:FSE:alnumx:m}}
698

699
700
701
702
703
* 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.
* If the VarName is not found in any store, nothing is replaced - the string '{{<VarName>}}' remains.
* If anywhere along the line an empty string is found, this **is** a value: therefore, the search will stop.
704

705
See also:
706

707
708
709
 * `store`_
 * `variable-escape`_
 * `sanitize-class`_
710

711

712
.. _`sql-variables`:
713

714
715
SQL variables
^^^^^^^^^^^^^
716

717
718
719
* The detection of an SQL command is case *insensitive*.
* Leading  whitespace will be skipped.
* The following commands are interpreted as SQL commands:
720

721
722
723
  * SELECT
  * INSERT, UPDATE, DELETE, REPLACE, TRUNCATE
  * SHOW, DESCRIBE, EXPLAIN, SET
724

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

730
* Example::
731

732
733
734
  {{SELECT id, name FROM Person}}
  {{SELECT id, name, IF({{feUser}}=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}} }} }}
735

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

738
   {{!SELECT ...}}
739

740

741
.. _`column-variables`:
742

743
744
745
746
747
Column variables
^^^^^^^^^^^^^^^^

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

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

750
751
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.
752
753
754

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

755
756
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
757
758
759
specific locations in the text will be (automatically by QFQ) replaced by values from other sources.

.. _`sanitize-class`:
760
761

Sanitize class
762
763
764
765
766
767
--------------

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

769
* All `predefined-variable-names`_ have a specific default sanitize class. For these variables, it's not necessary
770
  to specify a sanitize class.
771
* All other variables (Store: C, F) get by default the sanitize class defined in the corresponding form. If not defined,
772
773
  the default class is 'digit'.
* A default sanitize class can be overwritten by individual definition: *{{a:C:all}}*
774
775
776
* If there is a sanitized class specified, it applies to all given stores.

For QFQ variables and FormElements:
777
778
779
780

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


Only in FormElement:

795
796
797
798
799
800
801
802
803
804
+------------------+------+-------+-----------------------------------------------------------------------------------------+
| **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.                                                    |
+------------------+------+-------+-----------------------------------------------------------------------------------------+

805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
.. _`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 \\".
	* '-' - 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.
* Additionally a `defaultEscapeType` can be defined per `Form` (separate field in the Form Editor). This overwrites the
  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:-}}`.
831

832
833
834
835
836
Security
========

All values passed to QFQ will be:

837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
* 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**:

853
* Variables passed by the client (=Browser) are untrusted and use the default sanitize class 'digit' (if nothing else is
854
855
  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.
856
857
858
859

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

860
**QFQ security restriction**:
861

862
863
* GET parameter might contain urlencoded content (%xx). Therefore all GET parameter will be processed by 'urldecode()'.
  As a result a text like '%nn' in GET variables will always be decoded. It's not possible to transfer '%nn' itself.
864
* GET variables are limited to SECURITY_GET_MAX_LENGTH chars - any violation will stop QFQ.
865
866
867
868

Post Parameter
--------------

869
Per `FormElement` (HTML input) the default is to `htmlspecialchars()` the input. This means &<>'" will be encoded as htmlentity
870
and saved as a htmlentity in the database. In case any of these characters (e.g. for HTML tags) are
871
872
873
required, the encoding can be disabled per FormElement: `encode=none` (default is `specialchar`).

During Form load, htmlentities are decoded again.
874
875
876
877

$_SERVER
--------

878
All $_SERVER vars are htmlentities encoded (all, not only specialchars!) .
879
880
881
882

Honeypot
--------

883
884
Every QFQ Form contains 'honeypot'-HTML input elements (HTML: hidden & readonly). Which of them to use is configured in
`config.qfq.ini`_ (default:   'username', 'password' and 'email'). On every start of QFQ (form, report, save, ...),
885
886
887
888
889
these variables are tested if they are non-empty. In such a case a probably malicous bot has send the request and the
request will not be processed.

If any of the default configured variable names are needed (which will never be the case for QFQ), an explicit variable name
list have to be configured in `config.qfq.ini`_.
890

891
**QFQ security restriction**:
892

893
* The honeypot variables can't be used in GET or POST as regular HTML input elements - any values of them will terminate QFQ.
894
895
896
897

Violation
---------

898
On any violation, QFQ will sleep SECURITY_ATTACK_DELAY seconds (`config.qfq.ini`_) and than exit the running PHP process.
899
900
A detected attack leads to a complete white (=empty) page.

901
If SECURITY_SHOW_MESSAGE = true (`config.qfq.ini`_), at least a message is displayed after the delay.
902

903
904
Client Parameter via SIP
------------------------
905
906

Links with URL parameters, targeting to the local website, are typically SIP encoded. Instead of transferring the parameter
907
908
as part of the URL, only one uniqe GET parameter 's' is appended at the link. The parameter 's' is uniq (equal to a
timestamp) for the user. Assigned variables are stored as a part of the PHP user session on the server.
909
910
911
912
Two users might have the same value of parameter 's', but the content is completely independet.

Variables needed by Typo3 remains on the link and are not 'sip-encoded'.

913
914
.. _`SecureDirectFileAccess`:

915
916
917
918
919
920
921
Secure direct fileaccess
------------------------

If the application uploads files, mostly it's not necessary and often a security issue, to offer a direct download of
the uploaded files. Best is to create a directory, e.g. `fileadmin/protected` and deny direct access via webbrowser to it.
E.g. for Apache set a htaccess rule: ::

Carsten  Rose's avatar
Carsten Rose committed
922
		<Directory "/var/www/html/fileadmin/protected">
923
924
925
			Require all denied
		</Directory>

926
927
**Important**: all QFQ uploads should then save files in or below such a directory.

928
929
To offer download of those files, use the reserved columnname '_download':`download`_ or variants.

930
**Important**: To protect the installation against executing of uploaded malicious script code, disable PHP for the final upload
931
directory. E.g. `fileadmin`: ::
Carsten  Rose's avatar
Carsten Rose committed
932

Carsten  Rose's avatar
Carsten Rose committed
933
		<Directory "/var/www/html/fileadmin">
Carsten  Rose's avatar
Carsten Rose committed
934
935
936
			php_admin_flag engine Off
		</Directory>

937
938
This is in general a good security improvement for directories with user supplied content.

939
940
941
942
File upload
-----------

By default the mime type of every uploaded file is checked against a whitelist of allowed mime types. The mime type of
943
944
945
a file can be (easily) faked by an attacker. This check is good to handle regular user file upload for specific file types. To
prevent attacks against uploading and executing malicous code this won't help.

946
947
948
Instead prohibit the execution of user contributed files by the webserver config (`SecureDirectFileAccess`_).

.. _`store`:
949

950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
Store
=====

Only variables that are known in a specified store can be substituted.

 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
 |Name |Description                                                                             | Content                                                                    |
 +=====+========================================================================================+============================================================================+
 | F   | :ref:`STORE_FORM`: data not saved in database yet.                                     | All native *FormElements*. Recent values from the Browser.                 |
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
 | S   | :ref:`STORE_SIP`: Client parameter 's' will indicate the current SIP, which will be    | sip, r (recordId), form                                                    |
 |     | loaded from the SESSION repo to the SIP-Store.                                         |                                                                            |
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
 | R   | :ref:`STORE_RECORD`: Record - the current record loaded in the form                    | All columns of the current record from the current table                   |
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
 | B   | :ref:`STORE_BEFORE`: Record - the current record loaded in the form before any update  | All columns of the current record from the current table                   |
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
Carsten  Rose's avatar
Carsten Rose committed
967
 | P   | Parent record. E.g.: on multi & copy forms the current record of the outer query,      | All columns of the MultiSQL Statement from the table for the current row   |
968
969
970
971
972
973
974
975
976
977
978
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
 | D   | Default values column : The *table.column* specified *default value*.                  |                                                                            |
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
 | M   | Column type: The *table.column* specified *type*                                       |                                                                            |
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
 | C   | :ref:`STORE_CLIENT`: POST variable, if not found: GET variable                         | Parameter sent from the Client (=Browser).                                 |
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
 | T   | :ref:`STORE_TYPO3`: a) Bodytext (ttcontent record), b) Typo3 internal variables        | See Typo3 tt_content record configuration                                  |
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
 | V   | :ref:`STORE_VARS`: Generic variables                                                   |                                                                            |
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
Carsten  Rose's avatar
Carsten Rose committed
979
980
 | L   | :ref:`STORE_LDAP`: Will be filled on demand during processing of a *FormElement*       | Custom specified list of LDAP attributes                                   |
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
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
 | 0   | *Zero* - allways value: 0, might be helpful if a variable is empty or undefined and    | Any key                                                                    |
 |     | will be used in an SQL statement.                                                      |                                                                            |
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
 | E   | *Empty* - allways an empty string, might be helpful if a variable is empty or undefined| Any key                                                                    |
 |     | and will be used in an SQL statement                                                   |                                                                            |
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
 | Y   | :ref:`STORE_SYSTEM`: a) Database, b) helper vars for logging/debugging:                |                                                                            |
 |     | SYSTEM_SQL_RAW ... SYSTEM_FORM_ELEMENT_COLUMN, c) Any custom fields: CONTACT, HELP, ...|                                                                            |
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+

* Default *<prio>*: *FSRVD* - Form / SIP / Record / Vars / Table definition.
* Hint: Preferable, parameter should be submitted by SIP, not by Client (=URL).

  * Warning: Data submitted via 'Client' can be easily spoofed and altered.
  * Best: Data submitted via SIP never leaves the server, cannot be spoofed or altered by the user.
  * SIPs can _only_ be defined by using *Report*. Inside of *Report* use columns 'Link' (with attribute 's'), 'page?' or 'Page?'.

.. _predefined-variable-names:

Predefined variable names
-------------------------

.. _STORE_FORM:

Store: *FORM* - F
^^^^^^^^^^^^^^^^^

1008
* Sanitized: *yes*
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
* Represents the values in the form, typically before saving them.
* Used for:

  * *FormElements* who will be rerendered, after a parent *FormElement* has been changed by the user.
  * *FormElement* actions, before saving the form.
  * Values will be sanitized by the class configured in corresponding the *FormElement*. By default, the sanitize class is `alnumx`.

 +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
 | Name                            | Explanation                                                                                                                                |
 +=================================+============================================================================================================================================+
 | <FormElement name>              | Name of native *FormElement*. To get, exactly and only, the specified *FormElement* (for 'pId'): *{{pId:F}}*                               |
 +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+

.. _STORE_SIP:

Store: *SIP* - S
^^^^^^^^^^^^^^^^

1027
* Sanitized: *no*
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
* Filled automatically by creating links. E.g.:

  * in `Report` by using `_page?` or `_link` (with active 's')
  * in `Form` by using subrecords: 'new', 'edit', 'delete' links (system) or by column type `_page?`, `_link`.

 +-------------------------+-----------------------------------------------------------+
 | Name                    | Explanation                                               |
 +=========================+===========================================================+
 | sip                     | 13 char uniqid                                            |
 +-------------------------+-----------------------------------------------------------+
 | r                       | current record id                                         |
 +-------------------------+-----------------------------------------------------------+
 | form                    | current form name                                         |
 +-------------------------+-----------------------------------------------------------+
 | table                   | current table name                                        |
 +-------------------------+-----------------------------------------------------------+
 | urlparam                | all non Typo3 paramter in one string                      |
 +-------------------------+-----------------------------------------------------------+
 | <user defined>          | additional user defined link parameter                    |
 +-------------------------+-----------------------------------------------------------+

.. _STORE_RECORD:

Store: *RECORD* - R
^^^^^^^^^^^^^^^^^^^

1054
* Sanitized: *no*
1055
* Current record loaded in Form.
1056
* If r=0, all values are empty.
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068

 +------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
 | Name                   | Explanation                                                                                                                                      |
 +========================+==================================================================================================================================================+
 | <column name>          | Name of a column of the primary table (as defined in the current form). To get, exactly and only, the specified form *FormElement*: *{{pId:R}}*  |
 +------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+

.. _STORE_BEFORE:

Store: *BEFORE* - B
^^^^^^^^^^^^^^^^^^^

1069
* Sanitized: *no*
1070
* Current record loaded in Form without any modification.
1071
* If r=0, all values are empty.
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085

This store is handy to compare new and old values of a form.

 +------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
 | Name                   | Explanation                                                                                                                                      |
 +========================+==================================================================================================================================================+
 | <column name>          | Name of a column of the primary table (as defined in the current form). To get, exactly and only, the specified form *FormElement*: *{{pId:R}}*  |
 +------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+

.. _STORE_CLIENT:

Store: *CLIENT* - C
^^^^^^^^^^^^^^^^^^^

1086
* Sanitized: *yes*
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116

 +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
 | Name                    | Explanation                                                                                                                              |
 +=========================+==========================================================================================================================================+
 | s                       | =SIP                                                                                                                                     |
 +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
 | r                       | record id. Typically stored in SIP, rarely specified on the URL                                                                          |
 +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
 | keySemId                | always current Semester Id                                                                                                               |
 +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
 | keySemIdUser            | *{{keySemIdUser}}*, may be changed by user                                                                                               |
 +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
 | HTTP_HOST               | current HTTP HOST                                                                                                                        |
 +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
 | REMOTE_ADDR             | Client IP address                                                                                                                        |
 +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
 | '$_SERVER[*]'           | All other variables accessable by *$_SERVER[]*. Only the often used have a pre-defined sanitize class.                                   |
 +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
 | form                    | Unique name of current form                                                                                                              |
 +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
 | ANREDE                  | *{{sex}}* == male >> Sehr geehrter Herr, *{{sex}}* == female  Sehr geehrte Frau                                                          |
 +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
 | EANREDE                 | *{{sex}}* == male >> Dear Mr., *{{sex}}* == female >> Dear Mrs.                                                                          |
 +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------+

.. _STORE_TYPO3:

Store: *TYPO3* (Bodytext) - T
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

1117
* Sanitized: *no*
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128

 +-------------------------+-------------------------------------------------------------------+----------+
 | Name                    | Explanation                                                       | Note     |
 +=========================+===================================================================+==========+
 | form                    | Formname defined in ttcontent record bodytext                     | see note |
 |                         |                                                                   |          |
 |                         | * Fix. E.g. *form = person*                                       |          |
 |                         | * via SIP. E.g. *form = {{form}}*                                 |          |
 +-------------------------+-------------------------------------------------------------------+----------+
 | pageId                  | Record id of current Typo3 page                                   | see note |
 +-------------------------+-------------------------------------------------------------------+----------+
1129
1130
1131
1132
 | pageAlias               | Alias of current Typo3 page                                       | see note |
 +-------------------------+-------------------------------------------------------------------+----------+
 | pageTitle               | Title of current Typo3 page                                       | see note |
 +-------------------------+-------------------------------------------------------------------+----------+
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
 | pageType                | Current selected page type (typically URL parameter 'type')       | see note |
 +-------------------------+-------------------------------------------------------------------+----------+
 | pageLanguage            | Current selected page language (typically URL parameter 'L')      | see note |
 +-------------------------+-------------------------------------------------------------------+----------+
 | ttcontentUid            | Record id of current Typo3 content element                        | see note |
 +-------------------------+-------------------------------------------------------------------+----------+
 | feUser                  | Logged in Typo3 FE User                                           |          |
 +-------------------------+-------------------------------------------------------------------+----------+
 | feUserUid               | Logged in Typo3 FE User uid                                       |          |
 +-------------------------+-------------------------------------------------------------------+----------+
 | feUserGroup             | FE groups of logged in Typo3 FE User                              |          |
 +-------------------------+-------------------------------------------------------------------+----------+

1146
1147
* **note**: not available:

1148
  * in :ref:`dynamic-update` or
1149
1150
1151
1152
1153
1154
1155
  * by *FormElement* class 'action' with type 'beforeSave', 'afterSave', 'beforeDelete', 'afterDelete'.

.. _STORE_VARS:

Store: *VARS* - V
^^^^^^^^^^^^^^^^^

1156
* Sanitized: *no*
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169

 +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
 | Name                    | Explanation                                                                                                                                |
 +=========================+============================================================================================================================================+
 | random                  | random string with length of 32 chars, alphanum                                                                                            |
 +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
 | slaveId                 | see *FormElement* `action`                                                                                                                 |
 +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
 | filename                | Original filename of an uploaded file via an 'upload'-FormElement. Valid only during processing of the current 'upload'-formElement.       |
 +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
 | fileDestinaton          | Destination (path & filename) for an uploaded file. Defined in an 'upload'-FormElement.parameter. Valid: same as 'filename'.               |
 +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+

Carsten  Rose's avatar
Carsten Rose committed
1170
1171
1172
1173
1174
.. _STORE_LDAP:

Store: *LDAP* - L
^^^^^^^^^^^^^^^^^

1175
* Sanitized: *yes*
1176
* See also :ref:`LDAP`:
Carsten  Rose's avatar
Carsten Rose committed
1177
1178
1179
1180
1181
1182
1183
1184

 +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
 | Name                    | Explanation                                                                                                                                |
 +=========================+============================================================================================================================================+
 | <custom defined>        | See *ldapAttributes*                                                                                                                       |
 +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+


1185
1186
1187
1188
1189
1190

.. _STORE_SYSTEM:

Store: *SYSTEM* - Y
^^^^^^^^^^^^^^^^^^^

1191
* Sanitized: *no*
1192
1193
1194
1195

 +-------------------------+--------------------------------------------------------------------------+
 | Name                    | Explanation                                                              |
 +=========================+==========================================================================+
1196
 | DB_USER                 | defined in config.qfq.ini                                                |
1197
 +-------------------------+--------------------------------------------------------------------------+
1198
 | DB_SERVER               | defined in config.qfq.ini                                                |
1199
 +-------------------------+--------------------------------------------------------------------------+
1200
 | DB_NAME                 | defined in config.qfq.ini                                                |
1201
 +-------------------------+--------------------------------------------------------------------------+
1202
 | DB_INIT                 | defined in config.qfq.ini                                                |
1203
 +-------------------------+--------------------------------------------------------------------------+
1204
 | SQL_LOG                 | defined in config.qfq.ini, see `SQL_LOG`_                                |
1205
 +-------------------------+--------------------------------------------------------------------------+
1206
 | SQL_LOG_MODE            | defined in config.qfq.ini, `SQL_LOG_MODE`_                               |
1207
 +-------------------------+--------------------------------------------------------------------------+
1208
 | SHOW_DEBUG_INFO         | defined in config.qfq.ini                                                |
1209
 +-------------------------+--------------------------------------------------------------------------+
1210
 | CSS_LINK_CLASS_INTERNAL | defined in config.qfq.ini                                                |
1211
 +-------------------------+--------------------------------------------------------------------------+
1212
 | CSS_LINK_CLASS_EXTERNAL | defined in config.qfq.ini                                                |
1213
 +-------------------------+--------------------------------------------------------------------------+
1214
 | CSS_CLASS_QFQ_CONTAINER | defined in config.qfq.ini                                                |
1215
1216
1217
1218
1219
 +-------------------------+--------------------------------------------------------------------------+
 | EXT_PATH                | computed during runtime                                                  |
 +-------------------------+--------------------------------------------------------------------------+
 | SITE_PATH               | computed during runtime                                                  |
 +-------------------------+--------------------------------------------------------------------------+
1220
 | DATE_FORMAT             | defined in config.qfq.ini                                                |
1221
 +-------------------------+--------------------------------------------------------------------------+
1222
 | class                   | defined in config.qfq.ini (CSS_CLASS_QFQ_FORM) or form definition        |
1223
 +-------------------------+--------------------------------------------------------------------------+
1224
 | classPill               | defined in config.qfq.ini (CSS_CLASS_QFQ_FORM_PILL) or form definition   |
1225
 +-------------------------+--------------------------------------------------------------------------+
1226
 | classBody               | defined in config.qfq.ini (CSS_CLASS_QFQ_FORM_BODY) or form definition   |
1227
 +-------------------------+--------------------------------------------------------------------------+
1228
 | data-pattern-error      | defined in config.qfq.ini or form definition                             |
1229
 +-------------------------+--------------------------------------------------------------------------+
1230
 | data-require-error      | defined in config.qfq.ini or form definition                             |
1231
 +-------------------------+--------------------------------------------------------------------------+
1232
 | data-match-error        | defined in config.qfq.ini or form definition                             |
1233
 +-------------------------+--------------------------------------------------------------------------+
1234
 | data-error              | defined in config.qfq.ini or form definition                             |
1235
 +-------------------------+--------------------------------------------------------------------------+
1236
 | bsColumns               | defined in config.qfq.ini (FORM_BS_COLUMNS) or form definition           |
1237
 +-------------------------+--------------------------------------------------------------------------+
1238
 | bsLabelColumns          | defined in config.qfq.ini (FORM_BS_LABEL_COLUMNS) or form definition     |
1239
 +-------------------------+--------------------------------------------------------------------------+
1240
 | bsInputColumns          | defined in config.qfq.ini (FORM_BS_INPUT_COLUMNS) or form definition     |
1241
 +-------------------------+--------------------------------------------------------------------------+
1242
 | bsNoteColumns           | defined in config.qfq.ini (FORM_BS_NOTE_COLUMNS) or form definition      |
1243
1244
1245
1246
1247
1248
1249
1250
 +-------------------------+--------------------------------------------------------------------------+
 | sqlFinal                | computed during runtime, used for error reporting                        |
 +-------------------------+--------------------------------------------------------------------------+
 | sqlParamArray           | computed during runtime, used for error reporting                        |
 +-------------------------+--------------------------------------------------------------------------+
 | sqlCount                | computed during runtime, used for error reporting                        |
 +-------------------------+--------------------------------------------------------------------------+

Carsten  Rose's avatar
Carsten Rose committed
1251
1252
1253
1254
1255
.. _LDAP:

LDAP
====

1256
A form can retrieve data from LDAP server(s) to display or to save them. Configuration options for LDAP will be specified
Carsten  Rose's avatar
Carsten Rose committed
1257
in the *parameter* field of the *Form* and/or the *FormElement*. Definitions of the *FormElement* will overwrite definitions
1258
1259
of the *Form*. One LDAP Server can be configured per *FormElement*. Multiple *FormElements* might use individual LDAP
Server configurations.
1260

1261
To decide which Parameter should be placed on *Form.parameter* and which on *FormElement.parameter*: If LDAP access is ...
Carsten  Rose's avatar
Carsten Rose committed
1262
1263
1264
1265
1266
1267

* only necessary in one *FormElement*, most usefull setup is to specify all values in that specific *FormElement*,
* needed on multiple *FormElement*s (of the same *Form*, e.g. one *input* with *typeAhead*, one *note* and one *action*), it's more
  efficient to specify the base parameter *ldapServer*, *ldapBaseDn* in *Form.parameter* and the rest on the current
  *FormElement*.

1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
+-----------------------------+----------------------------------+---------------------------------------------------------------+------+-------------+----------+
| Parameter                   | Example                          | Description                                                   | Form | FormElement | Used for |
+=============================+==================================+===============================================================+======+=============+==========+
| ldapServer                  | directory.example.com            | Hostname. For LDAPS: `ldaps://directory.example.com:636`      | x    | x           | TA, FSL  |
+-----------------------------+----------------------------------+---------------------------------------------------------------+------+-------------+----------+
| ldapBaseDn                  | ou=Addressbook,dc=example,dc=com | Base DN to start the search                                   | x    | x           | TA, FSL  |
+-----------------------------+----------------------------------+---------------------------------------------------------------+------+-------------+----------+
| ldapAttributes              | cn, email                        | List of attributes to save in STORE_LDAP                      | x    | x           | FSL      |
+-----------------------------+----------------------------------+---------------------------------------------------------------+------+-------------+----------+
| ldapSearch                  | (mail=john.doe@example.com)      | Regular LDAP search expresssion                               | x    | x           | FSL      |
+-----------------------------+----------------------------------+---------------------------------------------------------------+------+-------------+----------+
| ldapTimeLimit               | 3 (default)                      | Maximum time to wait for an answer of the LDAP Server         | x    | x           | TA, FSL  |
+-----------------------------+----------------------------------+---------------------------------------------------------------+------+-------------+----------+
| ldapUseBindCredentials      | ldapUseBindCredentials=1         | Use LDAP_1_* crendentials from config.qfq.ini for ldap_bind() | x    | x           | TA, FSL  |
+-----------------------------+----------------------------------+---------------------------------------------------------------+------+-------------+----------+
| typeAheadLdap               | -                                | Enable LDAP as 'Typeahead' data source                        |      | x           | TA       |
+-----------------------------+----------------------------------+---------------------------------------------------------------+------+-------------+----------+
| typeAheadLdapSearch         | `(|(cn=*?*)(mail=*?*))`          | Regular LDAP search expresssion, returns upto typeAheadLimit  | x    | x           | TA       |
+-----------------------------+----------------------------------+---------------------------------------------------------------+------+-------------+----------+
| typeAheadLdapSearchPrefetch | `(mail=?)`                       | Regular LDAP search expresssion, typically return one record  | x    | x           | TA       |
+-----------------------------+----------------------------------+---------------------------------------------------------------+------+-------------+----------+
1289
1290
| typeAheadLdapSearchPerToken | -                                | Split search value in token and OR-combine every search with  | x    | x           | TA       |
|                             |                                  |  the individual tokens                                        |      |             |          |
1291
+-----------------------------+----------------------------------+---------------------------------------------------------------+------+-------------+----------+
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
| typeAheadLdapValuePrintf    | `'%s / %s', cn, mail`            | Custom format to display attributes, as `value`               | x    | x           | TA       |
+-----------------------------+----------------------------------+---------------------------------------------------------------+------+-------------+----------+
| typeAheadLdapIdPrintf       | `'%s', mail`                     | Custom format to display attributes, as `id`                  | x    | x           | TA       |
+-----------------------------+----------------------------------+---------------------------------------------------------------+------+-------------+----------+
| typeAheadLimit              | 20 (default)                     | Result will be limited to this number of entries              | x    | x           | TA       |
+-----------------------------+----------------------------------+---------------------------------------------------------------+------+-------------+----------+
| typeAheadPedantic           | typeAheadPedantic                | Activate 'pedantic' mode - only valid keys are allowed        | x    | x           | TA       |
+-----------------------------+----------------------------------+---------------------------------------------------------------+------+-------------+----------+
| typeAheadMinLength          | 2 (default)                      | Minimum number of characters before starting the search       | x    | x           | TA       |
+-----------------------------+----------------------------------+---------------------------------------------------------------+------+-------------+----------+
| fillStoreLdap               | -                                | Activate `Fill STORE LDAP` with the first retrieved record    |      | x           | FSL      |
+-----------------------------+----------------------------------+---------------------------------------------------------------+------+-------------+----------+
1304

Carsten  Rose's avatar
Carsten Rose committed
1305
* *typeAheadLimit*: there might be a hard limit on the server side (e.g. 100) - which can't be extended.
1306
1307
* *ldapUseBindCredentials* is only necessary if `anonymous` access is not possible. RDN and password has to be configured in
  `config.qfq.ini`.
Carsten  Rose's avatar
Carsten Rose committed
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323

.. _LDAP_Typeahead:

Typeahead (TA)
--------------

*Typeahead* offers continous searching of a LDAP directoy by using a regular *FormElement* of type *text*.
The *FormElement.parameter*=*typeAheadLdap* will trigger LDAP searches on every user **keystroke**
(starting after *typeAheadMinLength* keystrokes) for the current *FormElement* - this is different from *dynamicUpdate*
(triggered by leaving focus of an input element). Typeahead delivers a list of elements.

* *FormElement.parameter.typeAheadLdap* - activate the mode *Typeahead* - no value is needed, the existence is suffucient.
* *Form.parameter* or *FormElement.parameter*:

  * *ldapServer* = `directory.example.com`
  * *ldapBaseDn* =  `ou=Addressbook,dc=example,dc=com`
1324
  * *typeAheadLdapSearch* = `(|(cn=*?*)(mail=*?*))`
Carsten  Rose's avatar
Carsten Rose committed
1325
  * *typeAheadLdapValuePrintf* = `'%s / %s', cn, email`
1326
  * *typeAheadLdapIdPrintf* = `'%s', email`
Carsten  Rose's avatar
Carsten Rose committed
1327
  * Optional: *ldapUseBindCredentials* = 1
Carsten  Rose's avatar
Carsten Rose committed
1328
1329

All fetched LDAP values will be formatted with:
1330

Carsten  Rose's avatar
Carsten Rose committed
1331
* *typeAheadLdapValuePrintf*, shown to the user in a drop-down box and
1332
* *typeAheadLdapIdPrintf*, which represents the final data to save.
Carsten  Rose's avatar
Carsten Rose committed
1333

1334
1335
The `id/value` translation is compareable to a regular select drop-down box with id/value pairs.
Only attributes, defined in *typeAheadLdapValuePrintf* / *typeAheadLdapIdPrintf* will be fetched from the LDAP directory.
Carsten  Rose's avatar
Carsten Rose committed
1336
1337
1338
1339
1340
1341
To examine all possible values of an LDAP server, use the commandline tool `ldapsearch`. E.g.::

  ldapsearch -x -h directory.example.com -L -b ou=Addressbook,dc=example,dc=com "(mail=john.doe@example.com)"

All occurences of a '?' in *ldapSearch* will be replaced by the user data typed in via the text-*FormElement*.
The typed data will be escaped to fullfill LDAP search limitations.
1342
Regular *Form* variables might be used on all parameter and will be evaluated during form load (!) - *not* at the time when
Carsten  Rose's avatar
Carsten Rose committed
1343
1344
the user types something.

1345
1346
1347
1348
1349
Pedantic
^^^^^^^^

In case the typed value (technically this is the value of the *id*, latest in the moment when loosing the focus) have
to be a valid (= exist on the LDAP server), the *typeAheadPedantic* mode can be activated.
1350
If the user typed something and that is not a valid *id*, the client (=browser) will delete the input when loosing the focus.
1351
To identify the exact *id*, an additional search filter is necessary: `ypeAheadLdapSearchPrefetch` - see next topic.
1352
1353
1354
1355

* *Form.parameter* or *FormElement.parameter*:

  * *typeAheadPedantic*
1356
1357
1358
1359
1360
1361
1362
1363