Manual.rst 393 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
In `config-qfq-ini`_ specify the:
91

92
93
94
95
96
97
98
99
* installed `wkhtmltopdf` binary:

  * `WKHTMLTOPDF = /.../wkhtmltopdf`

* the site base URL:

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

100

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

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

   [FE][lockIP] = 0

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

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

115
116
117
118
**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!


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

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

144
145
146
147
148
149
150
151
152
153
154
155
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').

156
157
158
159
160
161
162
163
164
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.
165

166
167
Usage: `column-thumbnail`_.

168
169
170
171
172
173
174
175
176
177
178
179
180
181
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
182
* When the QFQ Extension is called the first time on the Typo3 Frontend, the file *<ext_dir>/qfq/sql/formEditor.sql* will
183
  played and fills the database with the *Form editor* records. This also happens automatically after each software update of QFQ.
184
185
* Configure Typoscript to include Bootstrap, jQuery, QFQ javascript and CSS files.

186
187
188
189
.. _setup-css-js:

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

	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 {
207
208
209
210
211
212
213
214
215
216
217
218
219
		file01 = typo3conf/ext/qfq/Resources/Public/JavaScript/jquery.min.js
		file02 = typo3conf/ext/qfq/Resources/Public/JavaScript/bootstrap.min.js
		file03 = typo3conf/ext/qfq/Resources/Public/JavaScript/validator.min.js
		file04 = typo3conf/ext/qfq/Resources/Public/JavaScript/jqx-all.js
		file05 = typo3conf/ext/qfq/Resources/Public/JavaScript/globalize.js
		file06 = typo3conf/ext/qfq/Resources/Public/JavaScript/tinymce.min.js
		file07 = typo3conf/ext/qfq/Resources/Public/JavaScript/EventEmitter.min.js
      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
220
221
	}

222

223
.. _form-editor:
224
225
226

FormEditor
----------
227

228
229
230
231
232
233
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:
234
235
236
237

::

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

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

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

		10 {
			# All forms
256
			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
257
258
259
260
261
262
263
			rbeg = <tr>
			rend = </tr>
			fbeg = <td>
			fend = </td>
		}
	}

264
265
266
267
268
269
270
271
272
273
274
275
276
.. _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.



277
278
279
280
281
.. _config-qfq-ini:

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

282
283
284
285
286
+-----------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| Keyword                     | Example                                               | Description                                                                |
+=============================+=======================================================+============================================================================+
| DB_INIT                     | DB_INIT=set names utf8                                | Global init for using the database.                                        |
+-----------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
287
288
289
290
291
| 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.                                           |
+-----------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
292
293
294
295
296
| 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                                                              |
+-----------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
297
298
| DB_INDEX_DATA               | DB_INDEX_DATA = 1                                     | Optional. Default: 1. Retrieve the current setting via {{_dbNameData:Y}}   |
| DB_INDEX_QFQ                | DB_INDEX_QFQ = 1                                      | Optional. Default: 1. Retrieve the current setting via {{_dbNameQfq:Y}}    |
299
300
+-----------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| SQL_LOG_MODE                | SQL_LOG_MODE=modify                                   | *all*: every statement will be logged - this might a lot.                  |
301
302
303
|                             |                                                       | *modify*: log only statements who change data. *error*: log only DB errors.|
|                             |                                                       | *none*: no SQL log at all.                                                 |
+-----------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
304
| SQL_LOG                     | SQL_LOG=typo3conf/sql.log                             | Filename to log SQL commands: relative to <site path> or absolute.         |
305
+-----------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
306
| MAIL_LOG                    | SQL_LOG=typo3conf/mail.log                            | Filename to log `sendEmail` commands: relative to <site path> or absolute. |
307
308
309
310
311
312
313
314
+-----------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| SEND_E_MAIL_OPTIONS         | SEND_E_MAIL_OPTIONS="-o tls=yes"                      | General options. Check: http://caspian.dotconf.net/menu/Software/SendEmail |
+-----------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| 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.                    |
+-----------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| REDIRECT_ALL_MAIL_TO        | REDIRECT_ALL_MAIL_TO=john@doe.com                     | If set, redirect all QFQ generated mails (Form, Report) to the specified.  |
+-----------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
Carsten  Rose's avatar
Carsten Rose committed
315
| CSS_CLASS_QFQ_CONTAINER     | CSS_CLASS_QFQ_CONTAINER=container                     | QFQ with own Bootstrap: 'container'.                                       |
316
317
|                             |                                                       | QFQ already nested in Bootstrap of mainpage: <empty>                       |
+-----------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
Carsten  Rose's avatar
Carsten Rose committed
318
319
320
| CSS_CLASS_QFQ_FORM          | CSS_CLASS_QFQ_FORM=qfq-color-base                     | Wrap around QFQ 'Form'.                                                    |
| 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.         |
321
322
323
+-----------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| DATE_FORMAT                 | DATE_FORMAT= yyyy-mm-dd                               | Possible options: yyyy-mm-dd, dd.mm.yyyy                                   |
+-----------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
Carsten  Rose's avatar
Carsten Rose committed
324
325
326
327
| 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       |
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
+-----------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| 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                         |
+-----------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| FORM_BUTTON_ON_CHANGE_CLASS | FORM_BUTTON_ON_CHANGE_CLASS=alert-info btn-info       | Color for save button after modification                                   |
+-----------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| 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.                                               |
+-----------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| 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                      |                                                                            |
+-----------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| ESCAPE_TYPE_DEFAULT         | ESCAPE_TYPE_DEFAULT=m                                 | All variables `{{...}}` get this escape class by default.                  |
|                             |                                                       | See `variable-escape`_.                                                    |
+-----------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| 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                                   |
| SECURITY_GET_MAX_LENGTH     | SECURITY_GET_MAX_LENGTH = 50                          | GET vars longer than 'x' chars triggers an `attack-recognized`.            |
|                             |                                                       | `ExceptionMaxLength`_                                                      |
+-----------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| 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)                                       |
| EXTRA_BUTTON_INFO_POSITION  | SYSTEM_EXTRA_BUTTON_INFO_POSITION=below               | 'auto' (default) or 'below'. See `extraButtonInfo`_                        |
| EXTRA_BUTTON_INFO_CLASS     | SYSTEM_EXTRA_BUTTON_INFO_CLASS=pull-right             | '' (default) or 'pull-right'. See `extraButtonInfo`_                       |
+-----------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| SAVE_BUTTON_TEXT            | SAVE_BUTTON_TEXT =                                    | Default text on the form save button. Typically none.                      |
| SAVE_BUTTON_TOOLTIP         | SAVE_BUTTON_TOOLTIP = save                            | Default tooltip on the form save button.                                   |
| SAVE_BUTTON_CLASS           | SAVE_BUTTON_CLASS = btn btn-default navbar-btn        | Default Bootstrap CSS class for buttons on top of the form                 |
| 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.                     |
| CLOSE_BUTTON_TOOLTIP        | CLOSE_BUTTON_TOOLTIP = close                          | Default tooltip on the form close button.                                  |
| CLOSE_BUTTON_CLASS          | CLOSE_BUTTON_CLASS = btn btn-default navbar-btn       | Default Bootstrap CSS class for buttons on top of the form                 |
| 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.                    |
| DELETE_BUTTON_TOOLTIP       | DELETE_BUTTON_TOOLTIP = delete                        | Default tooltip on the form delete button.                                 |
| DELETE_BUTTON_CLASS         | DELETE_BUTTON_CLASS = btn btn-default navbar-btn      | Default Bootstrap CSS class for buttons on top of the form                 |
| 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.                       |
| NEW_BUTTON_TOOLTIP          | NEW_BUTTON_TOOLTIP = new                              | Default tooltip on the form new button.                                    |
| NEW_BUTTON_CLASS            | NEW_BUTTON_CLASS = btn btn-default navbar-btn         | Default Bootstrap CSS class for buttons on top of the form                 |
| NEW_BUTTON_GLYPH_ICON       | NEW_BUTTON_GLYPH_ICON = glyphicon-plus                | Default Icon for the form new button                                       |
+-----------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| DIRTY_RECORD_TIMEOUT_SECONDS| DIRTY_RECORD_TIMEOUT_SECONDS = 900                    | Timeout for record locking. After this time, a record will be replaced     |
+-----------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| 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    |
+-----------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
384
385
386
387
388
389
390
| FILL_STORE_SYSTEM_BY_SQL_1  | FILL_STORE_SYSTEM_BY_SQL = SELECT s.id AS ...         | Specific values read from the database to fill the system store during QFQ |
| FILL_STORE_SYSTEM_BY_SQL_2  |                                                       | load. See `fillStoreSystemBySql`_ for a usecase.                           |
| FILL_STORE_SYSTEM_BY_SQL_3  |                                                       |                                                                            |
+-----------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| FILL_STORE_SYSTEM_BY_SQL_ERROR_MSG_1 | FILL_STORE_SYSTEM_BY_SQL_ERROR_MSG_1=No      | Only define an error message, if QFQ should stop running                   |
| FILL_STORE_SYSTEM_BY_SQL_ERROR_MSG_2 | current period found                         | in case of an SQL error or not exact one record.                           |
| FILL_STORE_SYSTEM_BY_SQL_ERROR_MSG_3 |                                              |                                                                            |
391
392
393
394
395
396
397
398
399
400
401
402
403
+-----------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| FORM_LANGUAGE_A_ID          | FORM_LANGUAGE_A__ID = 1                               | In Typo3 configured pageLanguage id. The number after the 'L' parameter.   |
| FORM_LANGUAGE_B_ID          |                                                       |                                                                            |
| FORM_LANGUAGE_C_ID          |                                                       |                                                                            |
| FORM_LANGUAGE_D_ID          |                                                       |                                                                            |
+-----------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| FORM_LANGUAGE_A_LABEL       | FORM_LANGUAGE_A_LABEL = english                       | Label shown in *Form editor*, on the 'basic' tab.                          |
| FORM_LANGUAGE_B_LABEL       |                                                       |                                                                            |
| FORM_LANGUAGE_C_LABEL       |                                                       |                                                                            |
| FORM_LANGUAGE_D_LABEL       |                                                       |                                                                            |
+-----------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| enterAsSubmit               | enterAsSubmit = 1                                     | 0: off, 1: Pressing *enter* in a form means *save* and *close*             |
+-----------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
404
| thumbnailDirSecure          | thumbnailDirSecure = fileadmin/protected/qfqThumbnail | Important: secure directory 'protected' (recursive) against direct access. |
405
| thumbnailDirPublic          | thumbnailDirPublic = typo3temp/qfqThumbnail           | Both thumbnail directories will be created if not existing.                |
Carsten  Rose's avatar
Carsten Rose committed
406
| cmdInkscape                 | cmdInkscape = inkscape                                | If inkscape is not available, specify an empty string.                     |
407
408
409
| cmdConvert                  | cmdConvert = convert                                  | GraphicsMagics 'convert' is recommended.                                   |
+-----------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+

410

411
412
413
414
Example: *typo3conf/config.qfq.ini*

::

415
416
417
418
419
420
421
422
	; QFQ configuration
	;
	; Save this file as: <Documentroot>/typo3conf/config.qfq.ini

	; Configure own URL, where `wkhtmltopdf` fetches pages and produces PDFs
	BASE_URL_PRINT = http://url.my/
	; WKHTMLTOPDF = /opt/wkhtmltox/bin/wkhtmltopdf

423
	; DB_INIT = set names utf8
424

425
426
427
	; auto | always | never
	; DB_UPDATE = auto

428
	; DB_INDEX_DATA = 1
429
	; DB_INDEX_QFQ = 1
430
431
432
433
434
435
436
437
438
439
440

	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>

441
442
	; <site path>/typo3conf/sql.log
	; SQL_LOG = typo3conf/sql.log
443
444

	; all|modify|error|none
445
	; SQL_LOG_MODE = modify
446

447
	; MAIL_LOG = typo3conf/mail.log
448
449
450
	; SEND_E_MAIL_OPTIONS = "-o ... "  - check http://caspian.dotconf.net/menu/Software/SendEmail

	; [auto|yes|no][,download]. 'auto': if BE User is logged in the value will be replaced by 'yes', else 'no'. Additional choose 'download'.
451
	; SHOW_DEBUG_INFO = auto
452

453
	; REDIRECT_ALL_MAIL_TO = john.doe@example.com
454
455

	; QFQ with own Bootstrap: 'container'. QFQ already nested in Bootstrap of mainpage: <empty>
456
	; CSS_CLASS_QFQ_CONTAINER =
457
458

	; Default background color, specified via CSS class
459
	; CSS_CLASS_QFQ_FORM =
460
461
	; CSS_CLASS_QFQ_FORM_PILL = qfq-color-grey-1
	; CSS_CLASS_QFQ_FORM_BODY = qfq-color-grey-2
462

463
	; yyyy-mm-dd, dd.mm.yyyy
464
	; DATE_FORMAT = yyyy-mm-dd
465
466
467

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

469
	;  validator.js: data-pattern-error="", data-required-error="", data-match-error="", data-error=""
470
471
472
473
	; FORM_DATA_PATTERN_ERROR =
	; FORM_DATA_REQUIRED_ERROR =
	; FORM_DATA_MATCH_ERROR =
	; FORM_DATA_ERROR =
474

475
	;  Default width of whole form
476
	; FORM_BS_COLUMNS = 12
477
478

	;  Default size for Bootstrap Form Elements
479
480
481
	; FORM_BS_LABEL_COLUMNS = 3
	; FORM_BS_INPUT_COLUMNS = 6
	; FORM_BS_NOTE_COLUMNS = 3
482

483
	; EDIT_FORM_PAGE = form
484

485
486
	; LDAP_1_RDN =
	; LDAP_1_PASSWORD =
487

488
	; ESCAPE_TYPE_DEFAULT=m
489

490
491
492
493
	; SECURITY_VARS_HONEYPOT=email,username,password
	; SECURITY_ATTACK_DELAY=5
	; SECURITY_SHOW_MESSAGE=true
	; SECURITY_GET_MAX_LENGTH=50
494

495
496
497
498
499
500
501
502
503
	; GFX_EXTRA_BUTTON_INFO_INLINE = <img src="file.png">
	; GFX_EXTRA_BUTTON_INFO_BELOW = <img src="file.png">
	; EXTRA_BUTTON_INFO_POSITION = auto | below
	; EXTRA_BUTTON_INFO_POSITION_CLASS = pull-right

	; SAVE_BUTTON_TEXT =
	; SAVE_BUTTON_TOOLTIP = save
	; SAVE_BUTTON_CLASS = btn btn-default navbar-btn
	; SAVE_BUTTON_GLYPH_ICON = glyphicon-ok
504

505
506
507
508
	; CLOSE_BUTTON_TEXT =
	; CLOSE_BUTTON_TOOLTIP = close
	; CLOSE_BUTTON_CLASS = btn btn-default navbar-btn
	; CLOSE_BUTTON_GLYPH_ICON = glyphicon-remove
509

510
511
512
513
	; DELETE_BUTTON_TEXT =
	; DELETE_BUTTON_TOOLTIP = delete
	; DELETE_BUTTON_CLASS = btn btn-default navbar-btn
	; DELETE_BUTTON_GLYPH_ICON = glyphicon-trash
514

515
516
517
518
	; NEW_BUTTON_TEXT =
	; NEW_BUTTON_TOOLTIP = new
	; NEW_BUTTON_CLASS = btn btn-default navbar-btn
	; NEW_BUTTON_GLYPH_ICON = glyphicon-plus
519

520
	; RECORD_LOCK_TIMEOUT_SECONDS = 900
521

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

525
526
527
	; FILL_STORE_SYSTEM_BY_SQL_1 = "SELECT id AS _periodId FROM Period WHERE start<=NOW() ORDER BY start DESC LIMIT 1"
	; Important: only define an error message, if QFQ should stop running in case of an SQL error or not exact 1 record.
	; FILL_STORE_SYSTEM_BY_SQL_ERROR_MSG_1 = No current period found
528

529
530
	; FORM_LANGUAGE_A_ID =       E.g. FORM_LANGUAGE_A_ID = 1
	; FORM_LANGUAGE_A_LABEL =    E.g. FORM_LANGUAGE_A_ID = English
531

532
533
534
535
536
537
538
539
540
541
542
	; FORM_LANGUAGE_B_ID =       E.g. FORM_LANGUAGE_B_ID = 2
	; FORM_LANGUAGE_B_LABEL =    E.g. FORM_LANGUAGE_B_ID = French

	; FORM_LANGUAGE_C_ID =       E.g. FORM_LANGUAGE_C_ID = 3
	; FORM_LANGUAGE_C_LABEL =    E.g. FORM_LANGUAGE_C_ID = Spain

	; FORM_LANGUAGE_D_ID =       E.g. FORM_LANGUAGE_D_ID = 4
	; FORM_LANGUAGE_D_LABEL =    E.g. FORM_LANGUAGE_D_ID = Chinese

	; Pressing the 'enter' key is equal to save and close
	; enterAsSubmit = 1
543

544
	; Attention: be sure that '<site path>/fileadmin/protected' is really locked down by a webserver directive.
545
	;   See https://docs.typo3.org/typo3cms/drafts/github/T3DocumentationStarter/Public-Info-053/Manual.html#secure-direct-fileaccess
546
	;
547
548
549
550
551
	; thumbnailDirSecure = fileadmin/protected/qfqThumbnail
	; thumbnailDirPublic = typo3temp/qfqThumbnail
	; cmdInkscape = inkscape
	; cmdConvert = convert

552
553
554
555
556
557
558
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          |
+----------------+--------------------------------------------------------------------------+
559

560
561
562
563
.. _`CustomVariables`:

Custom variables
^^^^^^^^^^^^^^^^
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578

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
579
.. _`fillStoreSystemBySql`:
580

Carsten  Rose's avatar
Carsten Rose committed
581
582
Fill STORE_SYSTEM by SQL
^^^^^^^^^^^^^^^^^^^^^^^^
583

Carsten  Rose's avatar
Carsten Rose committed
584
585
586
A specified SELECT statement in `config.qfq.ini`_ in variable `FILL_STORE_SYSTEM_BY_SQL_1` (or `FILL_STORE_SYSTEM_BY_SQL_2`,
or `FILL_STORE_SYSTEM_BY_SQL_3`) will be fired. The query should have 0 (nothing happens) or 1 row. All columns will be
**added** to the existing STORE_SYSTEM. Existing variables will be overwritten. Be careful not to overwrite system values.
587
 
Carsten  Rose's avatar
Carsten Rose committed
588
589
590
591
592
593
594
595
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: ::

  FILL_STORE_SYSTEM_BY_SQL_1 = "SELECT name FROM Person WHERE name='Doe'"
  FILL_STORE_SYSTEM_BY_SQL_ERROR_MSG_1 = Too many or to few "Doe's" in our database
596

597
.. _`periodId`:
598
599
600
601
602
603

periodId
''''''''

This is

Carsten  Rose's avatar
Carsten Rose committed
604
* a usecase, implemented via `fillStoreSystemBySql`_,
605
* a way to access `Period.id` with respect to the current period (the period itself is custom defined).
606
607
608
609
610

After a full QFQ installation, three things are prepared:

* a table `Period` (extend / change it to your needs, fill them with your periods),
* one sample record in table `Period`,
Carsten  Rose's avatar
Carsten Rose committed
611
* in `config.qfq.ini`_ the default definition of `FILL_STORE_SYSTEM_BY_SQL_1` will set the variable `periodId` during QFQ load.
612
613

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
614
*current* period.
615
616
617

In `config.qfq.ini`: ::

Carsten  Rose's avatar
Carsten Rose committed
618
	FILL_STORE_SYSTEM_BY_SQL_1 = 'SELECT id AS periodId FROM Period WHERE start<=NOW() ORDER BY start DESC LIMIT 1'
619
620
621
622
623
624
625
626
627
628
629
630
631

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`:
632
633
634
635
636
637
638
639
640
641
642
643

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.



644
645
646
647
648
649
.. _`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
650
the end. E.g. `my_long_variable_130`. Such a variable has an allowed length of 130 chars. Access the variable as
651
652
653
usual with the variable name: `{{my_long_variable_130:C:...}}`.


654
655
656
657
658
.. _local-documentation:

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

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

661
662
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
663
664
server). For a development server instead, deactivate the forbid rule of 'documentation'. In `.htaccess` (snippet from
Typo3 7.6 _.htaccess): ::
665

666
667
  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]
668
669
670
671
672
673

.. _concept:

Concept
=======

674
675
676
677
678
SIPs
----

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

679
The SIPs (=Server Id Pairs) are uniq timestamps, created/registered on the fly for a specific browser session (=user). Every SIP is
680
681
682
683
684
685
686
687
688
689
690
691
692
693
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.
694
695
696
697
698

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

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

700
701
702
703
704
705
706
* 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
707
708
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.
709
710
711
712
713
714

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

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

715
716
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.
717
718
719
720
721
722
723
724

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

 +-------------------+---------------------------------------------------------------------------------+
 | Name              | Explanation                                                                     |
 +===================+=================================================================================+
 | form              | Formname defined in ttcontent record bodytext                                   |
725
 |                   | - Fix. E.g.: **form = person**                                                  |
726
 |                   | - by SIP: **form = {{form:SE}}**                                                |
727
 |                   | - by SQL: **form = {{SELECT c.form FROM conference AS c WHERE c.id={{a:C}} }}** |
728
729
 +-------------------+---------------------------------------------------------------------------------+
 | r                 | <record id> The form will load the record with the specified id                 |
730
731
 |                   | - Variants: **r = 123**, by SQL: **r = {{SELECT ...}}**                         |
 |                   | - If not specified, the default is '0'                                          |
732
733
734
735
736
737
738
 +-------------------+---------------------------------------------------------------------------------+
 | <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)                                             |
 +-------------------+---------------------------------------------------------------------------------+
739
 | <level>.shead     | Static start token for whole <level>, independent if records are selected       |
740
 |                   | Shown before `head`.                                                            |
741
 +-------------------+---------------------------------------------------------------------------------+
742
 | <level>.stail     | Static end token for whole <level>, independent if records are selected.        |
743
 |                   | Shown after `tail`.                                                             |
744
745
746
747
 +-------------------+---------------------------------------------------------------------------------+
 | <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.     |
748
749
750
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.rbeg      | Start token for row.                                                            |
 +-------------------+---------------------------------------------------------------------------------+
751
 | <level>.rbgd      | Alternating (per row) token.                                                    |
752
753
754
755
756
757
758
759
760
761
762
 +-------------------+---------------------------------------------------------------------------------+
 | <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                                                                       |
 +-------------------+---------------------------------------------------------------------------------+
763
764
765
 | <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.             |
766
 |                   | Shown after `althead`                                                           |
767
 +-------------------+---------------------------------------------------------------------------------+
768
769
770
771
772
 | 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`. |
773
774
 +-------------------+---------------------------------------------------------------------------------+

775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
.. _`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
^^^^^^^^^^^^^

791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
+-------------+------------+------------+
| 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.
812

813
814
815
816
.. _`multi-database`:

Multi Database
^^^^^^^^^^^^^^
817

818
819
Base: T3 & QFQ
''''''''''''''
820

821
822
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
823
no problems on Typo3 updates and to have a clean separation between Typo3 and QFQ
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842

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

Every database needs to be configured via `config.qfq.ini`_ with it's own `index`.

`QFQ data` might switch between different 'data'-databases. In `config.qfq.ini` one main `QFQ data` index will be specified
in `DB_INDEX_QFQ`. If specific forms or reports should use a different database than that, `dbIndex` might change
`DB_INDEX_DATA` temporarily.

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

844
845
846
847
848
849

A `Form` will:

* load the own definition from `DB_INDEX_QFQ` (table `Form` and `FormElement`),
* loads and save data from/in `DB_INDEX_DATA` (config.qfq.in) / `dbIndex` (form.parameter.dbIndex),
* retrieve extra information via `dbIndexExtra` - this is useful to offer information from a database and save them in a
850
  different one.
851
852
853
854
855
856
857
858
859
860
861
862

The simplest setup, QFQ system & data in the same database, needs no DB_INDEX_QFQ / DB_INDEX_DATA definition in
`config.qfq.ini` or one or both of them set to '1'

To separate QFQ system and data, DB_INDEX_QFQ and DB_INDEX_DATA will have different indexes.


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

864
Note:
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890

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

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

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

891
Typically the credentials for `DB_1`  also have access to the T3 database.
892
893
894
895
896
897


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

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

900
901
902
.. _debug:

Debug
903
904
905
906
=====

SQL Logging
-----------
907

908
909
910
911
912
913
914
915
916
917
918
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.
919

920
921
922
923
924
925
926
927
928
929
930
931
932
933

.. _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.
934
935
936
937
938
939

  * *yes*:

    * Form:

      * For every internal link/button, show tooltips with decoded SIP on mouseover.
940
      * Shows an 'Edit form'-button (wrench symbol) on a form. The link points to the T3 page with the :ref:`form-editor`.
941
942
943
944
945
946
947
948
949
950
951
952

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

953
954
955
  * *download*:

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

958
959
.. _REDIRECT_ALL_MAIL_TO:

960
961
962
963
964
Redirect all mail to (catch all)
--------------------------------

File: `config.qfq.ini`_

965
966
967
968
969
970
971
972
973
974
* *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.
975
976
977

.. _variables:

978
979
Variable
========
980

981
982
Variables in QFQ are surrounded by double curly braces. Four different types of variable substitution functionality is
provided. Access to:
983

984
985
* `store-variables`_
* `sql-variables`_
986
987
* `row-column-variables`_
* `link-column-variables`_
988

989
Some examples, including nesting::
990

991
992
993
994
  # Store
  #---------------------------------------------
  {{r}}
  {{index:FS}}
995
  {{name:FS:alnumx:s:my default}}
996

997
998
999
  # SQL
  #---------------------------------------------
  {{SELECT name FROM person WHERE id=1234}}
1000

1001
  # Row columns
1002
1003
1004
  #---------------------------------------------
  {{10.pId}}
  {{10.20.pId}}
1005

1006
1007
1008
1009
1010
  # 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
1011

1012
1013
  # Link Columns
  {{p:form=Person&r=1|t:Edit Person|E|s AS link}}
1014

1015
Leading and trailing spaces inside curly braces are removed.
1016

1017
1018
  * *{{ SELECT "Hello World"   }}* becomes *{{SELECT "Hello World"}}*
  * *{{ varname   }}* becomes *{{varname}}*
1019

1020
1021
Types
-----
1022

1023
.. _`store-variables`:
1024

1025
1026
Store variables
^^^^^^^^^^^^^^^
1027

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

1030
* Example::
1031

1032
1033
1034
1035
  {{pId}}
  {{pId:FSE}}
  {{pId:FSE:digit}}
  {{name:FSE:alnumx:m}}
1036
  {{name:FSE:alnumx:m:John Doe}}
1037

1038
1039
1040
* 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.
1041
1042
* 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.
1043
* If anywhere along the line an empty string is found, this **is** a value: therefore, the search will stop.
1044

1045
See also:
1046

1047
1048
1049
 * `store`_
 * `variable-escape`_
 * `sanitize-class`_
1050

1051

1052
.. _`sql-variables`:
1053

1054
1055
SQL variables
^^^^^^^^^^^^^
1056

1057
1058
1059
* The detection of an SQL command is case *insensitive*.
* Leading  whitespace will be skipped.
* The following commands are interpreted as SQL commands:
1060

1061
1062
1063
  * SELECT
  * INSERT, UPDATE, DELETE, REPLACE, TRUNCATE
  * SHOW, DESCRIBE, EXPLAIN, SET
1064

1065
* A SQL Statement might contain variables, including additional SQL statements. Inner SQL queries will be executed first.
1066
1067
* 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.
1068

1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
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
''''''''''''''

1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
To access different databases in a `multi-database`_  setup, the database index can be specified after the opening curly
braces. ::

	{{[1]SELECT ... }}

For using the DB_INDEX_DATA and DB_INDEX_QFQ (`config.qfq.ini`_), it's a good practice to specify the variable name
instead of the numeric index. ::

   {{[{{DB_INDEX_DATA:Y}}]SELECT ...}}

If no dbIndex is given, `{{DB_INDEX_DATA:Y}}` is used.
1100

Carsten  Rose's avatar
Carsten Rose committed
1101

1102
1103
1104
1105
Example
'''''''

::
1106

1107
  {{SELECT id, name FROM Person}}
Carsten  Rose's avatar
Carsten Rose committed
1108
1109
  {{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}} }} }}
1110
1111
1112
  {{!SELECT id, name FROM Person}}
  {{[2]SELECT id, name FROM Form}}
  {{[{{DB_INDEX_QFQ:Y}}]SELECT id, name FROM Form}}
1113

1114
.. _`row-column-variables`:
1115

1116
1117
Row column variables
^^^^^^^^^^^^^^^^^^^^
1118
1119
1120

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

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

1123
1124
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.
1125
1126
1127

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

1128
1129
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
1130
1131
specific locations in the text will be (automatically by QFQ) replaced by values from other sources.

1132
1133
1134
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.

1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155

.. _`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}}

For better reading, the format string might be wrapped in single or double quotes (this ist optional): ::

	{{"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.


1156
.. _`sanitize-class`:
1157
1158

Sanitize class
1159
1160
--------------

1161
1162
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.
1163

1164
* If a value violates the specific sanitize class, the value becomes `!!<name of sanitize class>!!`. E.g. `!!gigit!!`.
1165
* Variables get by default the sanitize class defined in the corresponding `FormElement`. If not defined,
1166
1167
  the default class is 'digit'.
* A default sanitize class can be overwritten by individual definition: *{{a:C:all}}*
1168
1169

For QFQ variables and FormElements:
1170
1171
1172
1173

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


Only in FormElement:

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

1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209

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


1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
.. _`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 \\".
1224
1225
	* 'c' - config - the escape type configured in `config.qfq.ini`_.
	* ''  - the escape type configured in `config.qfq.ini`_.
1226
1227
1228
1229
1230
1231
1232
1233
	* '-' - 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.
1234
* Additionally a `defaultEscapeType` can be defined per `Form` (separate field in the *Form editor*). This overwrites the
1235
1236
1237
  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:-}}`.
1238

1239
1240
1241
1242
1243
Security
========

All values passed to QFQ will be:

1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
* 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**:

1260
* Variables passed by the client (=Browser) are untrusted and use the default sanitize class 'digit' (if nothing else is
1261
1262
  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.
1263
1264
1265
1266

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

1267
**QFQ security restriction**:
1268

1269
1270
* 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.
1271
* GET variables are limited to SECURITY_GET_MAX_LENGTH chars - any violation will stop QFQ.
1272
1273
1274
1275

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

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

During Form load, htmlentities are decoded again.
1281
1282
1283
1284

$_SERVER
--------

1285
All $_SERVER vars are htmlentities encoded (all, not only specialchars!) .
1286
1287
1288
1289

Honeypot
--------

1290
1291
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, ...),
1292
1293
1294
1295
1296
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`_.
1297

1298
**QFQ security restriction**:
1299

1300
* The honeypot variables can't be used in GET or POST as regular HTML input elements - any values of them will terminate QFQ.
1301
1302
1303
1304

Violation
---------

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

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

1310
1311
Client Parameter via SIP
------------------------
1312
1313

Links with URL parameters, targeting to the local website, are typically SIP encoded. Instead of transferring the parameter
1314
1315
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.
1316
1317
1318
1319
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'.

1320
1321
.. _`SecureDirectFileAccess`:

1322
1323
1324
1325
Secure direct fileaccess
------------------------

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

Carsten  Rose's avatar
Carsten Rose committed
1329
		<Directory "/var/www/html/fileadmin/protected">
1330
1331
1332
			Require all denied
		</Directory>

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

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

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