Manual.rst 392 KB
Newer Older
1
.. ==================================================
2
.. Header hierarchy
3
4
5
6
7
8
9
10
.. ==
..  --
..   ^^
..    ''
..     ;;
..      ,,
..
.. --------------------------------------------------
11
.. Best Practice T3 reST  https://docs.typo3.org/typo3cms/drafts/github/xperseguers/RstPrimer/
12
13
14
15
16
17
18
19
.. External Links: `Bootstrap <http://getbootstrap.com/>`_:
.. Add Images: https://wiki.typo3.org/ReST_Syntax#Images
..
.. -*- coding: utf-8 -*- with BOM.


.. include:: Includes.txt

20
21
22
23
24
.. _general:

General
=======

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

.. _installation:

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

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

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

42

43
44
.. _`preparation`:

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

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

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

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

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

* normalizer::normalize()

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

63
64
Preparation for Ubuntu 14.04::

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

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

73
	sudo apt install php7.0-intl
74
75
	sudo apt install pdftk libxrender1 file pdf2svg  # for file upload, PDF and 'HTML to PDF' (wkhtmltopdf), PDF split
	sudo apt install inkscape graphicsmagick         # to render thumbnails
76

77
.. _wkhtml:
78

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

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

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

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

92
In `configuration`_ specify the:
93

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

97

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

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

   [FE][lockIP] = 0

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

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

112
113
114
115
**Important**: Converting HTML to PDF gives no error message but RC=-1? Check carefully all includes of CSS, JS, images
and so on! Typically some of them fails to load and wkhtml stops running!


116
117
118
119
120
121
122
123
124
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
125
`print.php` with uses `wkhtmltopdf` to convert HTML to PDF.
126

127
128
129
130
131
132
133
134
135
136
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 {
137
		wrap = <a href="typo3conf/ext/qfq/qfq/api/print.php?id=|&type=2"><span class="glyphicon glyphicon-print" aria-hidden="true"></span> Printview</a>
138
139
140
		data = page:uid
	}

141
142
143
144
145
146
147
148
149
150
151
152
Send Email
^^^^^^^^^^

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

By default, `sendEmail` uses the local installed MTA, writes a logfile to `typo3conf/mail.log` and handles attachments
via commandline options. A basic HTML email support is implemented.

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

153
154
155
156
157
158
159
160
161
The Typo3 sendmail eco-system is not used at all by QFQ.

Thumbnail
^^^^^^^^^

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

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

163
164
Usage: `column-thumbnail`_.

165
166
167
168
169
170
171
172
173
174
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.

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

182
183
184
185
.. _setup-css-js:

Setup CSS & JS
^^^^^^^^^^^^^^
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
::

	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 {
203
204
205
206
207
208
209
210
211
212
213
214
215
		file01 = typo3conf/ext/qfq/Resources/Public/JavaScript/jquery.min.js
		file02 = typo3conf/ext/qfq/Resources/Public/JavaScript/bootstrap.min.js
		file03 = typo3conf/ext/qfq/Resources/Public/JavaScript/validator.min.js
		file04 = typo3conf/ext/qfq/Resources/Public/JavaScript/jqx-all.js
		file05 = typo3conf/ext/qfq/Resources/Public/JavaScript/globalize.js
		file06 = typo3conf/ext/qfq/Resources/Public/JavaScript/tinymce.min.js
		file07 = typo3conf/ext/qfq/Resources/Public/JavaScript/EventEmitter.min.js
      file08 = typo3conf/ext/qfq/Resources/Public/JavaScript/typeahead.bundle.min.js
		file09 = typo3conf/ext/qfq/Resources/Public/JavaScript/qfq.min.js

		# Only needed in case FormElement 'annotate' is used.
		file10 = typo3conf/ext/qfq/Resources/Public/JavaScript/fabric.min.js
      file11 = typo3conf/ext/qfq/Resources/Public/JavaScript/qfq.fabric.min.js
216
217
	}

218

219
.. _form-editor:
220
221
222

FormEditor
----------
223

224
225
226
Setup a *report* to manage all *forms*:

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

::

	# If there is a form given by SIP: show
234
	form={{form:SE}}
235

236
237
	# In case indexQfq is different from indexData, set indexQfq.
	dbIndex = {{indexQfq:Y}}
238

239
240
241
	10 {
		# List of Forms: Do not show this list of forms if there is a form given by SIP.
		# Table header.
242
		sql = SELECT CONCAT('p:{{pageId:T}}&form=form') as _pagen, '#', 'Name', 'Title', 'Table', '' FROM (SELECT 1) AS fake WHERE '{{form:SE}}'=''
243
		head = <table class="table table-hover qfq-table-50">
244
245
246
247
248
249
250
251
		tail = </table>
		rbeg = <thead><tr>
		rend = </tr></thead>
		fbeg = <th>
		fend = </th>

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

260
261
262
263
264
265
266
267
268
269
270
.. _install-checklist:

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

* Protect the directory `<T3 installation>/fileadmin/protected` in Apache against direct file access. Those directory
  should be used for confidential (uploaded / generated) data.
* Protect the directory `<T3 installation>/fileadmin` in Apache to not execute PHP Scripts - malicious uploads won't be executed.
* Setup a log rotation rule for `sqlLog`.
* Check that `sqlLogMode` is set to `modify`  on productive sites.

271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
.. _configuration:

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

.. _extension-manager-qfq-configuration:

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

+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| Keyword                       | Default / Example                                     | Description                                                                |
+===============================+=======================================================+============================================================================+
| Config                                                                                                                                                             |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| documentation                 | http://docs.typo3.org...                              | Link to the online documentation of QFQ. Every QFQ installation also       |
|                               |                                                       | contains a local copy: typo3conf/ext/qfq/Documentation/html/Manual.html    |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| thumbnailDirSecure            | fileadmin/protected/qfqThumbnail                      | Important: secure directory 'protected' (recursive) against direct access. |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| thumbnailDirPublic            | typo3temp/qfqThumbnail                                | Both thumbnail directories will be created if not existing.                |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| cmdInkscape                   | inkscape                                              | If inkscape is not available, specify an empty string.                     |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| cmdConvert                    | convert                                               | GraphicsMagics 'convert' is recommended.                                   |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| cmdWkhtmltopdf                | /usr/bin/wkhtmltopdf                                  | PathFilename of wkhtmltopdf.                                               |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| baseUrl                       | http://example.com                                    | URL where wkhtmltopdf will fetch the HTML (no parameter, those comes later)|
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| sendEMailOptions              | -o tls=yes                                            | General options. Check: http://caspian.dotconf.net/menu/Software/SendEmail |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| dateFormat                    | yyyy-mm-dd                                            | Possible options: yyyy-mm-dd, dd.mm.yyyy                                   |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| Dynamic                                                                                                                                                            |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| fillStoreSystemBySql1|2|3     | SELECT s.id AS ...                                    | Specific values read from the database to fill the system store during QFQ |
|                               |                                                       | load. See `fillStoreSystemBySql`_ for a usecase.                           |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| fillStoreSystemBySqlErrorMsg2 | No current period found                               | Only define an error message, if QFQ should stop running                   |
|                               |                                                       | in case of an SQL error or not exact one record.                           |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| Debug                                                                                                                                                              |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| sqlLogMode                    | modify                                                | *all*: every statement will be logged - this might a lot.                  |
|                               |                                                       | *modify*: log only statements who change data. *error*: log only DB errors.|
|                               |                                                       | *none*: no SQL log at all.                                                 |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| sqlLog                        | typo3conf/sql.log                                     | Filename to log SQL commands: relative to <site path> or absolute.         |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| mailLog                       | typo3conf/mail.log                                    | Filename to log `sendEmail` commands: relative to <site path> or absolute. |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| showDebugInfo                 | auto                                                  | FE - Possible values: yes|no|auto|download. For 'auto': If a BE User is    |
|                               |                                                       | logged in, a debug information will be shown on the FE.                    |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| redirectAllMailTo             | john@doe.com                                          | If set, redirect all QFQ generated mails (Form, Report) to the specified.  |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| Database                                                                                                                                                           |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| dbInit                        | dbInit=set names utf8                                 | Global init for using the database.                                        |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| update                        | auto                                                  | 'auto': apply DB Updates only if there is a newer version.                 |
|                               |                                                       | 'always': apply DB Updates always, especially play formEditor.sql every    |
|                               |                                                       | time QFQ is called - *not* recommended!                                    |
|                               |                                                       | 'never': never apply DB Updates.                                           |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| indexData                     | 1                                                     | Optional. Default: 1. Retrieve the current setting via {{_dbNameData:Y}}   |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| indexQfq                      | 1                                                     | Optional. Default: 1. Retrieve the current setting via {{_dbNameQfq:Y}}    |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| Security                                                                                                                                                           |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| escapeTypeDefault             | m                                                     | All variables `{{...}}` get this escape class by default.                  |
|                               |                                                       | See `variable-escape`_.                                                    |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| securityVarsHoneypot          | email,username,password                               | If empty: no check. All named variables will rendered as INPUT elements    |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| securityAttackDelay           | 5                                                     | If an attack is detected, sleep 'x' seconds and exit PHP process           |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| securityShowMessage           | true                                                  | If an attack is detected, show a message                                   |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| securityGetMaxLength          | 50                                                    | GET vars longer than 'x' chars triggers an `attack-recognized`.            |
|                               |                                                       | `ExceptionMaxLength`_                                                      |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| Form-Config                                                                                                                                                        |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| recordLockTimeoutSeconds      | 900                                                   | Timeout for record locking. After this time, a record will be replaced     |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| enterAsSubmit                 | enterAsSubmit = 1                                     | 0: off, 1: Pressing *enter* in a form means *save* and *close*             |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| editFormPage                  | form                                                  | T3 Pagealias to edit a form.                                               |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| formDataPatternError          | please check pattern error                            | Customizable error message used in validator.js. 'pattern' violation       |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| formDataRequiredError         | missing value                                         | Customizable error message used in validator.js. 'required' fields         |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| formDataMatchError            | type error                                            | Customizable error message used in validator.js. 'match' retype mismatch   |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| formDataError                 | generic error                                         | Customizable error message used in validator.js. 'no specific' given       |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| Form-Layout                                                                                                                                                        |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| cssClassQfqContainer          | container                                             | QFQ with own Bootstrap: 'container'.                                       |
|                               |                                                       | QFQ already nested in Bootstrap of mainpage: <empty>                       |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| cssClassQfqForm               | qfq-color-base                                        | Wrap around QFQ 'Form'.                                                    |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| cssClassQfqFormPill           | qfq-color-grey-1                                      | Wrap around title bar for pills: CSS Class, typically a background color.  |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| cssClassQfqFormBody           | qfq-color-grey-2                                      | Wrap around FormElements: CSS Class, typically a background color.         |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| formBsColumns                 | 12                                                    | The whole form will be wrapped in 'col-md-??'. Default is 12 for 100%      |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| formBsLabelColumns            | 3                                                     | Default number of BS columns for the 'label'-column                        |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| formBsInputColumns            | 6                                                     | Default number of BS columns for the 'input'-column                        |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| formBsNoteColumns             | 3                                                     | Default number of BS columns for the 'note'-column                         |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| extraButtonInfoInline         | <img src="info.png">                                  | Image for `extraButtonInfo`_ (inline)                                      |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| extraButtonInfoBelow          | <img src="info.png">                                  | Image for `extraButtonInfo`_ (below)                                       |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| extraButtonInfoPosition       | below                                                 | 'auto' (default) or 'below'. See `extraButtonInfo`_                        |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| extraButtonInfoClass          | pull-right                                            | '' (default) or 'pull-right'. See `extraButtonInfo`_                       |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| Form-Language                                                                                                                                                      |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| formLanguage[ABCD]Id          | -  E.g.: 1                                            | In Typo3 configured pageLanguage id. The number after the 'L' parameter.   |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| formLanguage[ABCD]Label       | -  E.G.: english                                      | Label shown in *Form editor*, on the 'basic' tab.                          |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| saveButtonText                | -                                                     | Text on the form save button. Typically none.                              |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| saveButtonTooltip             | Save                                                  | Tooltip on the form save button.                                           |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| saveButtonClass               | btn btn-default navbar-btn                            | Bootstrap CSS class for save button on top of the form                     |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| saveButtonClassOnChange       | alert-info btn-info                                   | Bootstrap CSS class for save button showing 'data changed'                 |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| saveButtonGlyphIcon           | glyphicon-ok                                          | Icon for the form save button                                              |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| closeButtonText               | -                                                     | Text on the form close button. Typically none.                             |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| closeButtonTooltip            | close                                                 | Tooltip on the form close button.                                          |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| closeButtonClass              | btn btn-default navbar-btn                            | Bootstrap CSS class for close button on top of the form                    |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| closeButtonGlyphIcon          | glyphicon-remove                                      | Icon for the form close button                                             |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| deleteButtonText              | -                                                     | Text on the form delete button. Typically none.                            |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| deleteButtonTooltip           | delete                                                | Tooltip on the form delete button.                                         |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| deleteButtonClass             | btn btn-default navbar-btn                            | Bootstrap CSS class for delete button on top of the form                   |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| deleteButtonGlyphIcon         | glyphicon-trash                                       | Icon for the form delete button                                            |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| newButtonText                 | -                                                     | Text on the form new button. Typically none.                               |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| newButtonTooltip              | new                                                   | Tooltip on the form new button.                                            |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| newButtonClass                | btn btn-default navbar-btn                            | Bootstrap CSS class for new button on top of the form                      |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| newButtonGlyphIcon            | glyphicon-plus                                        | Icon for the form new button                                               |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
438
439


440
441
442
443
444
.. _config-qfq-ini:

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

445
446
447
448
449
450
451
452
453
454
455
456
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| Keyword                       | Example                                               | Description                                                                |
+===============================+=======================================================+============================================================================+
| DB_<n>_USER                   | DB_1_USER=qfqUser                                     | Credentials configured in MySQL                                            |
| DB_<n>_PASSWORD               | DB_1_PASSWORD=1234567890                              | Credentials configured in MySQL                                            |
| DB_<n>_SERVER                 | DB_1_SERVER=localhost                                 | Hostname of MySQL Server                                                   |
| DB_<n>_NAME                   | DB_1_NAME=qfq_db                                      | Database name                                                              |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| LDAP_1_RDN                    | LDAP_1_RDN='ou=Admin,ou=example,dc=com'               | Credentials for non-anonymous LDAP access. At the moment only one set of   |
| LDAP_1_PASSWORD               | LDAP_1_PASSWORD=mySecurePassword                      |                                                                            |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+

457

458

459
460
461
462
Example: *typo3conf/config.qfq.ini*

::

463
464
	; QFQ configuration
	;
465
	; Save this file as: <site path>/typo3conf/config.qfq.ini
466
467
468
469
470
471
472
473
474
475
476
477
478

	DB_1_USER = <DBUSER>
	DB_1_SERVER = <DBSERVER>
	DB_1_PASSWORD = <DBPW>
	DB_1_NAME = <DB>

	; DB_2_USER = <DBUSER>
	; DB_2_SERVER = <DBSERVER>
	; DB_2_PASSWORD = <DBPW>
	; DB_2_NAME = <DB>

	; Access via {{TECHNICAL_CONTACT:Y}}
	; TECHNICAL_CONTACT = john@doe.com
479

480
481
	; LDAP_1_RDN =
	; LDAP_1_PASSWORD =
482

483

484
485
486
487
488
489
490
After parsing the configuration, the following variables will be set automatically in STORE_SYSTEM:

+----------------+--------------------------------------------------------------------------+
| _dbNameData    | Can be used to dynamically access the current selected database          |
+----------------+--------------------------------------------------------------------------+
| _dbNameQfq     | Can be used to dynamically access the current selected database          |
+----------------+--------------------------------------------------------------------------+
491

492
493
494
495
.. _`CustomVariables`:

Custom variables
^^^^^^^^^^^^^^^^
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510

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

Carsten  Rose's avatar
Carsten Rose committed
511
.. _`fillStoreSystemBySql`:
512

Carsten  Rose's avatar
Carsten Rose committed
513
514
Fill STORE_SYSTEM by SQL
^^^^^^^^^^^^^^^^^^^^^^^^
515

516
517
A specified SELECT statement in `configuration`_ in variable `fillStoreSystemBySql1` (or `2`,
or `3`) will be fired. The query should have 0 (nothing happens) or 1 row. All columns will be
Carsten  Rose's avatar
Carsten Rose committed
518
**added** to the existing STORE_SYSTEM. Existing variables will be overwritten. Be careful not to overwrite system values.
519
 
Carsten  Rose's avatar
Carsten Rose committed
520
521
522
523
524
525
This option is useful to make generic custom values, saved in the database, accessible to all QFQ Report and Forms.
Access such variables via `{{<varname>:Y}}`.

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

526
527
  fillStoreSystemBySql1: SELECT name FROM Person WHERE name='Doe'
  fillStoreSystemBySqlErrorMsg1: Too many or to few "Doe's" in our database
528

529
.. _`periodId`:
530
531
532
533
534
535

periodId
''''''''

This is

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

539
After a full QFQ installation:
540
541
542
543
544

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

Websites, delivering semester data, schoolyears schedules, or any other type or periods, often need an index to the
Carsten  Rose's avatar
Carsten Rose committed
545
*current* period.
546

547
In configuration_: ::
548

549
	fillStoreSystemBySql1: SELECT id AS periodId FROM Period WHERE start<=NOW() ORDER BY start DESC LIMIT 1
550
551
552
553
554
555
556
557
558
559
560
561
562

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

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

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

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

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

.. _`DbUserPrivileges`:
563
564
565
566
567
568
569
570
571
572
573
574

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.



575
576
577
578
579
.. _`ExceptionMaxLength`:

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

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


585
586
587
588
589
.. _local-documentation:

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

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

592
593
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
594
595
server). For a development server instead, deactivate the forbid rule of 'documentation'. In `.htaccess` (snippet from
Typo3 7.6 _.htaccess): ::
596

597
598
  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]
599
600
601
602
603
604

.. _concept:

Concept
=======

605
606
607
608
609
SIPs
----

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

610
The SIPs (=Server Id Pairs) are uniq timestamps, created/registered on the fly for a specific browser session (=user). Every SIP is
611
612
613
614
615
616
617
618
619
620
621
622
623
624
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.
625
626
627
628
629

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

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

631
632
633
634
635
636
637
* 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
638
639
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.
640
641
642
643
644
645

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

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

646
647
The title of the QFQ content element will not be rendered on the frontend. It's only visible to the webmaster in the
backend for orientation.
648
649
650
651
652
653
654
655

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

 +-------------------+---------------------------------------------------------------------------------+
 | Name              | Explanation                                                                     |
 +===================+=================================================================================+
 | form              | Formname defined in ttcontent record bodytext                                   |
656
 |                   | - Fix. E.g.: **form = person**                                                  |
657
 |                   | - by SIP: **form = {{form:SE}}**                                                |
658
 |                   | - by SQL: **form = {{SELECT c.form FROM conference AS c WHERE c.id={{a:C}} }}** |
659
660
 +-------------------+---------------------------------------------------------------------------------+
 | r                 | <record id> The form will load the record with the specified id                 |
661
662
 |                   | - Variants: **r = 123**, by SQL: **r = {{SELECT ...}}**                         |
 |                   | - If not specified, the default is '0'                                          |
663
664
665
666
667
668
669
 +-------------------+---------------------------------------------------------------------------------+
 | <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)                                             |
 +-------------------+---------------------------------------------------------------------------------+
670
 | <level>.shead     | Static start token for whole <level>, independent if records are selected       |
671
 |                   | Shown before `head`.                                                            |
672
 +-------------------+---------------------------------------------------------------------------------+
673
 | <level>.stail     | Static end token for whole <level>, independent if records are selected.        |
674
 |                   | Shown after `tail`.                                                             |
675
676
677
678
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.head      | Dynamic start token for whole <level>. Only if at least one record is select.   |
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.tail      | Dynamic end token for whole <level>. Only if at least one record is select.     |
679
680
681
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.rbeg      | Start token for row.                                                            |
 +-------------------+---------------------------------------------------------------------------------+
682
 | <level>.rbgd      | Alternating (per row) token.                                                    |
683
684
685
686
687
688
689
690
691
692
693
 +-------------------+---------------------------------------------------------------------------------+
 | <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                                                                       |
 +-------------------+---------------------------------------------------------------------------------+
694
695
696
 | <level>.althead   | If <level>.sql is empty, these token will be rendered.                          |
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.altsql    | If <level>.sql is empty, these query will be fired. No sub queries.             |
697
 |                   | Shown after `althead`                                                           |
698
 +-------------------+---------------------------------------------------------------------------------+
699
 | debugShowBodyText | If='1' and configuration_:*showDebugInfo: yes*, shows a tooltip with bodytext   |
700
 +-------------------+---------------------------------------------------------------------------------+
701
 | sqlLog            | Overwrites configuration_: `SQL_LOG`_ . Only affects `Report`, not `Form`.      |
702
 +-------------------+---------------------------------------------------------------------------------+
703
 | sqlLogMode        | Overwrites configuration_: `SQL_LOG_MODE`_ . Only affects `Report`, not `Form`. |
704
705
 +-------------------+---------------------------------------------------------------------------------+

706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
.. _`qfq-database`:

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

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

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

.. _`system-tables`:

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

722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
+-------------+------------+------------+
| Name        | Use        | Database   |
+=============+============+============+
| Clipboard   | Temporary  | QFQ        |
+-------------+------------+------------+
| Cron        | Persistent | QFQ        |
+-------------+------------+------------+
| Dirty       | Temporary  | QFQ | Data |
+-------------+------------+------------+
| Form        | Persistent | QFQ        |
+-------------+------------+------------+
| FormElement | Persistent | QFQ        |
+-------------+------------+------------+
| MailLog     | Persistent | QFQ | Data |
+-------------+------------+------------+
| Period      | Persistent | Data       |
+-------------+------------+------------+
| Split       | Persistent | Data       |
+-------------+------------+------------+

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

744
745
746
747
.. _`multi-database`:

Multi Database
^^^^^^^^^^^^^^
748

749
750
Base: T3 & QFQ
''''''''''''''
751

752
753
QFQ typically interacts with one database, the QFQ database. The database used by Typo3 is typically a separate one.
Theoretically it might be the same (never tested), but it's strongly recommended to use a separated QFQ database to have
754
no problems on Typo3 updates and to have a clean separation between Typo3 and QFQ
755
756
757
758
759
760
761
762
763
764
765
766

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

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

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

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

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

769
770
771
`QFQ data` might switch between different 'data'-databases. In configuration_ one main `QFQ data` index will be specified
in `indexQfq`. If specific forms or reports should use a different database than that, `dbIndex` might change
`indexData` temporarily.
772
773

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

775
776
777

A `Form` will:

778
779
* load the own definition from `indexQfq` (table `Form` and `FormElement`),
* loads and save data from/in `indexData` (config.qfq.in) / `dbIndex` (form.parameter.dbIndex),
780
* retrieve extra information via `dbIndexExtra` - this is useful to offer information from a database and save them in a
781
  different one.
782

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

786
To separate QFQ system and data, indexQfq and indexData will have different indexes.
787
788
789
790
791
792
793


A Multi Database setup might be useful for:

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

795
Note:
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817

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

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

818
In config-qfq-ini_ mutliple database credentials can be prepared. Mandatory is at least one credential setup like
819
820
821
`DB_1_USER`, `DB_1_SERVER`, `DB_1_PASSWORD`, `DB_1_NAME`. The number '1' indicates the `dbIndex`. Increment the number
to specify further database credential setups.

822
Typically the credentials for `DB_1`  also have access to the T3 database.
823
824
825
826
827
828


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

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

831
832
833
.. _debug:

Debug
834
835
836
837
=====

SQL Logging
-----------
838

839
configuration_
840
841
842

.. _SQL_LOG:

843
* *sqlLog*
844
845

  * Filename where to log SQL queries and statistical data.
846
  * File is relative to the `<site path>` or absolute (starting with '/').
847
848
849
  * 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.
850

851
852
853

.. _SQL_LOG_MODE:

854
* *sqlLogMode: all|modify|error|none*
855
856
857
858
859
860
861

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

862
* *showDebugInfo = [yes|no|auto],[download]*
863
864

  If active, displays additional information in the Frontend (FE). This is typically helpful during development.
865
866
867
868
869
870

  * *yes*:

    * Form:

      * For every internal link/button, show tooltips with decoded SIP on mouseover.
871
      * Shows an 'Edit form'-button (wrench symbol) on a form. The link points to the T3 page with the :ref:`form-editor`.
872
873
874
875
876
877
878
879
880

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

881
882
    * *showDebugInfo = yes*  (BE session exist)
    * *showDebugInfo = no*   (no BE session)
883

884
885
886
  * *download*:

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

889
890
.. _REDIRECT_ALL_MAIL_TO:

891
892
893
Redirect all mail to (catch all)
--------------------------------

894
configuration_
895

896
* *redirectAllMailTo=john@doe.com*
897
898
899
900
901
902
903
904
905

  * 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.
906
907
908

.. _variables:

909
910
Variable
========
911

912
913
Variables in QFQ are surrounded by double curly braces. Four different types of variable substitution functionality is
provided. Access to:
914

915
916
* `store-variables`_
* `sql-variables`_
917
918
* `row-column-variables`_
* `link-column-variables`_
919

920
Some examples, including nesting::
921

922
923
924
925
  # Store
  #---------------------------------------------
  {{r}}
  {{index:FS}}
926
  {{name:FS:alnumx:s:my default}}
927

928
929
930
  # SQL
  #---------------------------------------------
  {{SELECT name FROM person WHERE id=1234}}
931

932
  # Row columns
933
934
935
  #---------------------------------------------
  {{10.pId}}
  {{10.20.pId}}
936

937
938
939
940
941
  # 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
942

943
944
  # Link Columns
  {{p:form=Person&r=1|t:Edit Person|E|s AS link}}
945

946
Leading and trailing spaces inside curly braces are removed.
947

948
949
  * *{{ SELECT "Hello World"   }}* becomes *{{SELECT "Hello World"}}*
  * *{{ varname   }}* becomes *{{varname}}*
950

951
952
Types
-----
953

954
.. _`store-variables`:
955

956
957
Store variables
^^^^^^^^^^^^^^^
958

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

961
* Example::
962

963
964
965
966
  {{pId}}
  {{pId:FSE}}
  {{pId:FSE:digit}}
  {{name:FSE:alnumx:m}}
967
  {{name:FSE:alnumx:m:John Doe}}
968

969
970
971
* 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.
972
973
* If the VarName is not found and a default value is given, the default is returned.
* If no value is found, nothing is replaced - the string '{{<VarName>}}' remains.
974
* If anywhere along the line an empty string is found, this **is** a value: therefore, the search will stop.
975

976
See also:
977

978
979
980
 * `store`_
 * `variable-escape`_
 * `sanitize-class`_
981

982

983
.. _`sql-variables`:
984

985
986
SQL variables
^^^^^^^^^^^^^
987

988
989
990
* The detection of an SQL command is case *insensitive*.
* Leading  whitespace will be skipped.
* The following commands are interpreted as SQL commands:
991

992
993
994
  * SELECT
  * INSERT, UPDATE, DELETE, REPLACE, TRUNCATE
  * SHOW, DESCRIBE, EXPLAIN, SET
995

996
* A SQL Statement might contain variables, including additional SQL statements. Inner SQL queries will be executed first.
997
998
* 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.
999

1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
Result: string
''''''''''''''

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

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

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

   {{!SELECT ...}}

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

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

1020
1021
1022
1023
1024
To access different databases in a `multi-database`_  setup, the database index can be specified after the opening curly
braces. ::

	{{[1]SELECT ... }}

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

1028
   {{[{{indexData:Y}}]SELECT ...}}
1029

1030
If no dbIndex is given, `{{indexData:Y}}` is used.
1031

Carsten  Rose's avatar
Carsten Rose committed
1032

1033
1034
1035
1036
Example
'''''''

::
1037

1038
  {{SELECT id, name FROM Person}}
Carsten  Rose's avatar
Carsten Rose committed
1039
1040
  {{SELECT id, name, IF({{feUser:T0}}=0,'Yes','No')  FROM Person WHERE id={{r:S}} }}
  {{SELECT id, city FROM Address AS adr WHERE adr.accId={{SELECT id FROM Account AS acc WHERE acc.name={{feUser:T0}} }} }}
1041
1042
  {{!SELECT id, name FROM Person}}
  {{[2]SELECT id, name FROM Form}}
1043
  {{[{{indexQfq:Y}}]SELECT id, name FROM Form}}
1044

1045
.. _`row-column-variables`:
1046

1047
1048
Row column variables
^^^^^^^^^^^^^^^^^^^^
1049
1050
1051

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

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

1054
1055
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.
1056
1057
1058

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

1059
1060
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
1061
1062
specific locations in the text will be (automatically by QFQ) replaced by values from other sources.

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

1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076

.. _`link-column-variables`:

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

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

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

1077
For better reading, the format string might be wrapped in single or double quotes (this is optional): ::
1078
1079
1080
1081
1082
1083
1084
1085
1086

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

These variables are especially helpful in:

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


1087
.. _`sanitize-class`:
1088
1089

Sanitize class
1090
1091
--------------

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

1095
* If a value violates the specific sanitize class, the value becomes `!!<name of sanitize class>!!`. E.g. `!!digit!!`.
1096
* Variables get by default the sanitize class defined in the corresponding `FormElement`. If not defined,
1097
  the default class is 'digit'.
1098
* A default sanitize class can be overwritten by individual definition: *{{a:C:alnumx}}*
1099
1100

For QFQ variables and FormElements:
1101
1102
1103
1104

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


Only in FormElement:

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

1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140

Rules for CheckType Auto (by priority):

* TypeAheadSQL or TypeAheadLDAP defined: **alnumx**
* Table definition
	* integer type: **digit**
	* floating point number: **numerical**
* FE Type
	* 'password', 'note': **all**
	* 'editor', 'text' and encode = 'specialchar': **all**
* None of the above: **alnumx**


1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
.. _`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 \\".
1155
1156
	* 'c' - config - the escape type configured in `configuration`_.
	* ''  - the escape type configured in `configuration`_.
1157
1158
1159
1160
1161
1162
	* '-' - 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.
1163
* In configuration_ a global `escapeTypeDefault` can be defined. The configured escape type applies to all substituted
1164
  variables, who *do not* contain a *specific* escape type.
1165
* Additionally a `defaultEscapeType` can be defined per `Form` (separate field in the *Form editor*). This overwrites the
1166
1167
  global definition of `configuration`. By default, every `Form.defaultEscapeType` = 'c' (=config), which means the setting
  in `configuration`_.
1168
* To suppress a default escape type, define the `escape type` = '-' on the specific variable. E.g.: `{{name:FE:alnumx:-}}`.
1169

1170
1171
1172
1173
1174
Security
========

All values passed to QFQ will be:

1175
* Checked against max. length and allowed content, on the client and on the server side. On the server side, the check
1176
1177
1178
  happens before any further processing. The 'length' and 'allowed' content is specified per `FormElement`. 'digit' or
  'alnumx' is the default. Violating the rules will stop the 'save record' process (Form) or result in an empty
  value (Report). If a variable is not replaced, check the default sanitize class.
1179
1180
1181

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

1182
* UTF8 normalized (normalizer::normalize) to unify different ways of composing characters. It's more a database interest,
1183
1184
1185
1186
  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
1187
affected by SQL injection. To prevent SQL injection, every variable is by default escaped with `mysqli::real_escape_string`.
1188
1189
1190

**QFQ notice**:

1191
* Variables passed by the client (=Browser) are untrusted and use the default sanitize class 'digit' (if nothing else is
1192
1193
  specified). If alpha characters are submitted, the content violates `digit` and becomes therefore
  `!!<name of sanitize class>!!` - there is no error message. Best is to always use SIP or digits.
1194
1195
1196
1197

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

1198
**QFQ security restriction**:
1199

1200
1201
* 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.
1202
1203
1204
1205
1206
1207

* GET values are limited to securityGetMaxLength (extension-manager-qfq-configuration_) chars - any violation will
  stop QFQ. Individual exceptions are defined via ExceptionMaxLength_.

* GET parameter 'type' and 'L' might affected by (T3, configuration dependent) cache poisoning. If they contain non digit
  values, only the first character is used (if this is a digit) or completely cleaned (else).
1208
1209
1210
1211

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

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

During Form load, htmlentities are decoded again.
1217
1218
1219
1220

$_SERVER
--------

1221
All $_SERVER vars are htmlentities encoded (all, not only specialchars!) .
1222
1223
1224
1225

Honeypot
--------

1226
Every QFQ Form contains 'honeypot'-HTML input elements (HTML: hidden & readonly). Which of them to use is configured in
1227
`configuration`_ (default:   'username', 'password' and 'email'). On every start of QFQ (form, report, save, ...),
1228
1229
1230
1231
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
1232
list have to be configured in `configuration`_.
1233

1234
**QFQ security restriction**:
1235

1236
* The honeypot variables can't be used in GET or POST as regular HTML input elements - any values of them will terminate QFQ.
1237
1238
1239
1240

Violation
---------

1241
On any violation, QFQ will sleep `securityAttackDelaySeconds` (`configuration`_) and than exit the running PHP process.
1242
1243
A detected attack leads to a complete white (=empty) page.

1244
If `securityShowMessage`: true (`configuration`_), at least a message is displayed after the delay.
1245

1246
1247
Client Parameter via SIP
------------------------
1248
1249

Links with URL parameters, targeting to the local website, are typically SIP encoded. Instead of transferring the parameter
1250
1251
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.
1252
1253
1254
1255
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'.

1256
1257
.. _`SecureDirectFileAccess`:

1258
1259
Secure direct file access
-------------------------
1260
1261

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

Carsten  Rose's avatar
Carsten Rose committed
1265
		<Directory "/var/www/html/fileadmin/protected">
1266
1267
1268
			Require all denied
		</Directory>

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

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

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

Carsten  Rose's avatar
Carsten Rose committed
1276
		<Directory "/var/www/html/fileadmin">
Carsten  Rose's avatar
Carsten Rose committed
1277
1278
1279
			php_admin_flag engine Off
		</Directory>

1280
1281
This is in general a good security improvement for directories with user supplied content.

1282
1283
1284
File upload
-----------

1285
By default the mime type of every uploaded file is checked against a white list of allowed mime types. The mime type of
1286
1287
1288
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.

1289
1290
1291
Instead prohibit the execution of user contributed files by the webserver config (`SecureDirectFileAccess`_).

.. _`store`:
1292

1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
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
1310
 | 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   |
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
 | 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
1322
1323
 | L   | :ref:`STORE_LDAP`: Will be filled on demand during processing of a *FormElement*       | Custom specified list of LDAP attributes                                   |
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
1324
1325
1326
</