Installation.rst 59.9 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
.. ==================================================
.. ==================================================
.. ==================================================
.. Header hierarchy
.. ==
..  --
..   ^^
..    ""
..     ;;
..      ,,
..
.. --------------------------------------------used to the update the records specified ------
.. Best Practice T3 reST: https://docs.typo3.org/m/typo3/docs-how-to-document/master/en-us/WritingReST/CheatSheet.html
..             Reference: https://docs.typo3.org/m/typo3/docs-how-to-document/master/en-us/WritingReST/Index.html
.. Italic *italic*
.. Bold **bold**
.. Code ``text``
.. External Links: `Bootstrap <http://getbootstrap.com/>`_
19
.. Internal Link: :ref:downloadButton (default url text) or :ref:`download Button<downloadButton>` (explicit url text)
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
.. Add Images:    .. image:: ../Images/a4.jpg
..
..
.. Admonitions
..           .. note::   .. important::     .. tip::     .. warning::
.. Color:   (blue)       (orange)           (green)      (red)
..
.. Definition:
.. some text becomes strong (only one line)
..      description has to indented

.. -*- coding: utf-8 -*- with BOM.

.. include:: Includes.txt


.. _installation:

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

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

* General: QFQ is coded to run on Linux hosts, preferable on Debian derivates like Ubuntu.
* HTML to PDF conversion - command `wkhtmltopdf`.
* Concatenation of PDF files - command `pdfunite`.
46
* Convert of images to PDF files - command `img2pdf`.
47
48
49
* PDF decrypt (used for merge with pdfunite) - command `qpdf`.
* PDF decrypt (used for merge with pdfunite) - command `gs` - in case `qpdf` is not successful.
* Mime type detection for uploads - command `file`.
50
51
* Split PDF into JPG - command `convert`.
* Repair PDF - command `pdftocairo`.
52
53
54
55
56
57
58
59
60
61
62
63
64
65


.. _`preparation`:

Preparation
-----------

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

To normalize UTF8 input, *php-intl* package is needed by

* normalizer::normalize()

66
For the :ref:`download` function, the programs `img2pdf`, `pdfunite`, `qpdf`, `gs` and `file` are necessary to concatenate PDF files.
67
68
69
70

Preparation for Ubuntu::

  sudo apt install php-intl
71
72
  # for file upload, PDF and 'HTML to PDF' (wkhtmltopdf), PDF split
  sudo apt install poppler-utils libxrender1 file pdf2svg qpdf ghostscript img2pdf
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
  sudo apt install inkscape imagemagick            # to render thumbnails

.. _wkhtml:

wkhtmltopdf
^^^^^^^^^^^

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

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

In :ref:`configuration` specify::

    config.cmdWkhtmltopdf:  /opt/wkhtmltox/bin/wkhtmltopdf
    config.baseUrl: http://www.example.com/

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

    config.cmdWkhtmltopdf: LD_LIBRARY_PATH=/opt/wkhtmltox/lib /opt/wkhtmltox/bin/wkhtmltopdf

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

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

   [FE][lockIP] = 0

.. warning::

    ``[FE][lockIP] = 0`` 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
    Typoscript) from specific IPs **or** if a FE-User is logged in.

If there are problems with converting/downloading FE_GROUP protected pages, check :ref:`configuration` `showDebugInfo = download` to debug.

.. note::

    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! Verify the correct loading of all elements
    by calling the site via a regular browser and bypassing any browser cache (Ctrl F5).

.. note::

   On Ubuntu, Apache is started by default with `LANG=C`. This is true even when the OS default locale is set to `en_US.UTF-8`.
   Furthermore, all child processes of Apache will inherit `LANG=C`. Some PHP functions (like 'escapeshellarg()')
   or `wkhtml` will strip all non-ASCII characters (e.g. commandline arguments).

   Let Apache run with the system locale: `/etc/apache/envvars`, activate the line `. /etc/default/locale` and restart Apache.

Checklist wkhtml problems
"""""""""""""""""""""""""

* `config.baseUrl` is configured and correct. The baseUrl has to be the same protocol as the website (http or https).
* To track down problems:

  * In :ref:`configuration` set `debug.showDebugInfo=auto,download`.
  * Do the download.
  * Check :ref:`QFQ_LOG` for any output.
  * Grab the URL given in the :ref:`QFQ_LOG`, open a browser in private mode (no existing browser session) and open the URL.
  * Check the `--cookie-jar '/tmp/qfq.cookie....'` file for the cookie.
  * Call wkhtml manually on the webserver, with the same options as given in the :ref:`QFQ_LOG`.

HTML to PDF conversion
""""""""""""""""""""""

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

Print
"""""

Different browser prints the same page in different variations. To prevent this, QFQ implements a small PHP wrapper
`print.php` with uses `wkhtmltopdf` to convert HTML to PDF.

Provide a `print this page`-link (replace 'current pageId' )::

  <a href="typo3conf/ext/qfq/Classes/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 {
    wrap = <a href="typo3conf/ext/qfq/Classes/Api/print.php?id=|&type=99"><span class="glyphicon glyphicon-print" aria-hidden="true"></span> Printview</a>
    data = page:uid
  }

Send Email
^^^^^^^^^^

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

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

179
180
**NOTE**: The `log` directory has been moved into `qfqProject` with a recent upgrade of QFQ. For backwards compatibility logs are still stored in `fileadmin/protected/log/` if that directory already exists.

181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
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').

Nevertheless, on latest system the TLS support is broken - please check :ref:`sendEmailProblem`.

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

.. _`thumbnail`:

Thumbnail
^^^^^^^^^

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

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

Usage: :ref:`column-thumbnail`.

Setup
-----

* Install the extension via the Extension Manager.

  * 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: 18.12.0).

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

210
* Copy/rename the file *<site path>/fileadmin/protected/qfqProject/conf/example.qfq.json* to *<site path>/fileadmin/protected/qfqProject/conf/qfq.json*.
211
212
  Configure the necessary settings :ref:`configuration`
  The configuration file is outside of the extension directory, to not loose it during de-install and install again.
Marc Egger's avatar
Marc Egger committed
213

214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
* When the QFQ Extension is called the first time on the Typo3 frontend, the file *<ext_dir>/Classes/Sql/formEditor.sql* will
  played and fills the database with the *Form editor* records. This also happens automatically after each update of QFQ.
* Configure Typoscript to include Bootstrap, jQuery, QFQ javascript and CSS files.

.. _setup-css-js:

Setup CSS & JS
^^^^^^^^^^^^^^
::

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

    page.includeCSS {
        file01 = typo3conf/ext/qfq/Resources/Public/Css/bootstrap.min.css
        file02 = typo3conf/ext/qfq/Resources/Public/Css/bootstrap-theme.min.css
        file03 = typo3conf/ext/qfq/Resources/Public/Css/jqx.base.css
        file04 = typo3conf/ext/qfq/Resources/Public/Css/jqx.bootstrap.css
        file05 = typo3conf/ext/qfq/Resources/Public/Css/qfq-bs.css
        file06 = typo3conf/ext/qfq/Resources/Public/Css/tablesorter-bootstrap.css
        file07 = typo3conf/ext/qfq/Resources/Public/Css/font-awesome.min.css

        # Only needed in case FullCalendar is used
        file08 = typo3conf/ext/qfq/Resources/Public/Css/fullcalendar.min.css
    }

    page.includeJS {
        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
        file10 = typo3conf/ext/qfq/Resources/Public/JavaScript/jquery.tablesorter.combined.min.js
        file11 = typo3conf/ext/qfq/Resources/Public/JavaScript/jquery.tablesorter.pager.min.js
        file12 = typo3conf/ext/qfq/Resources/Public/JavaScript/widget-columnSelector.min.js

        # Only needed in case FormElement 'annotate' is used.
        file13 = typo3conf/ext/qfq/Resources/Public/JavaScript/fabric.min.js
        file14 = typo3conf/ext/qfq/Resources/Public/JavaScript/qfq.fabric.min.js

        # Only needed in case FullCalendar is used
        file15 = typo3conf/ext/qfq/Resources/Public/JavaScript/moment.min.js
        file16 = typo3conf/ext/qfq/Resources/Public/JavaScript/fullcalendar.min.js
    }


.. _form-editor:

FormEditor
----------

Setup a *report* to manage all *forms*:

* Create a Typo3 page.
* Set the 'URL Alias' to `form` (recommended) or the individual defined value in parameter `editFormPage` (configuration_).
* Insert a content record of type *qfq*.
277
278
279
* In the bodytext insert the following code (see explanation of code: :ref:`reportAsFile`)::

    file=_formEditor
280
281
282
283
284
285
286
287
288

.. _install-checklist:

Installation: Check List
------------------------

* Protect the directory `<T3 installation>/fileadmin/protected` in Apache against direct file access.

  * `<T3 installation>/fileadmin/protected/` should be used for confidential (uploaded / generated) data.
289
  * `<T3 installation>/fileadmin/protected/qfqProject/log/...` is the default place for QFQ log files.
290
291
292
293
294
295
296
297
298
299
300

* 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. With `none` you have no chance to find out who changed
  which data and `all` really logs a mass of data.

.. _configuration:

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

301
.. _qfq-project-path-php:
302

Marc Egger's avatar
Marc Egger committed
303
304
305
qfq.project.path.php
^^^^^^^^^^^^^^^^^^^^

306
307
The file `qfq.project.path.php` provides the path to the qfqProject directory.

Carsten  Rose's avatar
Carsten Rose committed
308
309
* The qfqProject directory contains the qfq configuration file (see :ref:`qfq.json`) as well as forms and reports which
  are saved as files. See :ref:`formAsFile` and :ref:`reportAsFile`.
Marc Egger's avatar
Marc Egger committed
310
311
312
* The file `qfq.project.path.php` is located/created in the root directory of the application. (Where index.php is located)
* This file only returns the path to the qfq project directory where logs, config (`qfq.json`), report files and form files are located.
* If the file does not exist, it is created and the project path is set as follows:
Marc Egger's avatar
Marc Egger committed
313

Marc Egger's avatar
Marc Egger committed
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
  * Does the deprecated config file typo3conf/config.qfq.php exist? Then set the qfq project path to `fileadmin/protected/qfqProject` (config is migrated automatically to qfqProject).
  * If not, does `fileadmin/protected exist`? Then set the qfq project path to `fileadmin/protected/qfqProject`.
  * If not, then set qfq project path to `../` (i.e. outside the app directory where index.php is located)

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

   <?php

   /**
   QFQ project path configuration
   !! ATTENTION !!: The files in the project directory should NOT be served by your http server!
   Only exception: The app directory inside the project directory may be served.
   */

   return 'fileadmin/protected/qfqProject'; // path relative to app directory (i.e. location of this file).


331
.. _qfq.json:
Marc Egger's avatar
Marc Egger committed
332
333
334
335
336
337

qfq.json
^^^^^^^^

* Additionally to the keywords bellow one can also override the configuration values defined in the Typo3 extension manager: :ref:`extension-manager-qfq-configuration`
  * e.g. if `qfq.json` contains `"flagProduction":"no"` then this value is taken instead of the one set in the extension manager.
338

339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
| 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. Only one set supported.                                       |
| LDAP_1_PASSWORD               | "LDAP_1_PASSWORD"="mySecurePassword"                  |                                                                                                          |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
| PASSWORD_HASH_TYPE            | "PASSWORD_HASH_TYPE"="PASSWORD_BCRYPT"                | Password hashing algorithm used for "p" action class. See: :ref:`variable-escape`                        |
|                               |                                                       | Possible values: "PASSWORD_ARGON2I" (QFQ default), "PASSWORD_BCRYPT", "PASSWORD_DEFAULT" (PHP default)   |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
356

Marc Egger's avatar
Marc Egger committed
357
Example: *fileadmin/protected/qfqProject/qfq.json*: ::
358

Marc Egger's avatar
Marc Egger committed
359
360
361
362
363
   {
     "DB_1_USER": "<DBUSER>",
     "DB_1_SERVER": "<DBSERVER>",
     "DB_1_PASSWORD": "<DBPW>",
     "DB_1_NAME": "<DB>",
364

Marc Egger's avatar
Marc Egger committed
365
366
367
368
     "DB_2_USER": "<OPTIONAL DBUSER>",
     "DB_2_SERVER": "<OPTIONAL DBSERVER>",
     "DB_2_PASSWORD": "<OPTIONAL DBPW>",
     "DB_2_NAME": "<OPTIONAL DB>",
369

Marc Egger's avatar
Marc Egger committed
370
371
372
     "LDAP_1_RDN": "<OPTIONAL> ou=Admin,ou=example,dc=com",
     "LDAP_1_PASSWORD": "<OPTIONAL> mySecurePassword"
   }
373

Marc Egger's avatar
Marc Egger committed
374
.. _config-qfq-php:
375

Marc Egger's avatar
Marc Egger committed
376
377
config.qfq.php
^^^^^^^^^^^^^^
378

Marc Egger's avatar
Marc Egger committed
379
**DEPRECATED** : use `qfq.json` as described above. :ref:`qfq.json`
380
381
382
383
384
385

.. _extension-manager-qfq-configuration:

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

Marc Egger's avatar
Marc Egger committed
386
* These configuration values can be overwritten by `qfq.json`. :ref:`qfq.json`
387
388
389
390

+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| Keyword                           | Default / Example                                     | Description                                                                |
+===================================+=======================================================+============================================================================+
Carsten  Rose's avatar
Carsten Rose committed
391
| **Config**                                                                                                                                                             |
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| flagProduction                    | yes                                                   | yes|no: used to differentiate production and development site.             |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| render                            | single                                                | both|single: QFQ will show form and/or report. In most cases only one at a |
|                                   |                                                       | time is needed. Options: 'single' (default) or 'both' (legacy). In mode    |
|                                   |                                                       | 'single' prefer 'form' over 'report'.                                      |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| maxFileSize                       | 10M                                                   | If empty, take minimum of 'post_max_size' and 'upload_max_filesize'.       |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| baseUrl                           | http://example.com                                    | URL where wkhtmltopdf will fetch the HTML (no parameter, those comes later)|
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| dateFormat                        | yyyy-mm-dd                                            | Possible options: yyyy-mm-dd, dd.mm.yyyy.                                  |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| 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.                     |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
411
412
413
414
415
| cmdConvert                        | convert                                               | Image-/GraphicsMagics 'convert' is recommended.                            |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| cmdPdf2svg                        | pdf2svg                                               | Convert PDF to SVG.                                                        |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| cmdPdftocairo                     | pdftocairo                                            | Poppler based.                                                             |
416
417
418
419
420
421
422
423
424
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| cmdWkhtmltopdf                    | /usr/bin/wkhtmltopdf                                  | PathFilename of wkhtmltopdf. Optional variables like LD_LIBRARY_PATH=...   |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| cmdQpdf                           | qpdf                                                  | PathFilename of qpdf. Optional variables like LD_LIBRARY_PATH=...          |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| cmdGs                             | gs                                                    | PathFilename of gs. Optional variables like LD_LIBRARY_PATH=...            |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| cmdPdfunite                       | pdfunite                                              | PathFilename of pdfunite. Optional variables like LD_LIBRARY_PATH=...      |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
425
426
| cmdImg2pdf                        | img2pdf                                               | PathFilename of img2pdf. Optional variables like LD_LIBRARY_PATH=...       |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
427
428
| sendEMailOptions                  | -o tls=yes                                            | General options. Check: http://caspian.dotconf.net/menu/Software/SendEmail |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
Marc Egger's avatar
Marc Egger committed
429
430
| reportAsFileAutoExport            | no                                                    | Auto export of qfq reports to files. See :ref:`reportAsFile`               |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
Carsten  Rose's avatar
Carsten Rose committed
431
| **Dynamic**                                                                                                                                                            |
432
433
434
435
436
437
438
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| fillStoreSystemBySql1/2/3         | SELECT s.id AS ...                                    | Specific values read from the database to fill the system store during QFQ |
|                                   |                                                       | load. See :ref:`fillStoreSystemBySql` for a usecase.                       |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| fillStoreSystemBySqlErrorMsg1/2/3 | 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.                           |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
Carsten  Rose's avatar
Carsten Rose committed
439
| **Debug**                                                                                                                                                              |
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| throwExceptionGeneralError        | auto                                                  | | *yes*: 'general errors' in QFQ (PHP) will throw an exception.            |
|                                   |                                                       | | *auto*: becomes 'yes', if 'flagProduction'!='yes', else 'no'.            |
|                                   |                                                       | | *no*: 'general errors' in QFQ (PHP) will be silently ignored.            |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| formSubmitLogMode                 | all                                                   | | *all*: every form submission will be logged.                             |
|                                   |                                                       | | *none*: no logging.                                                      |
|                                   |                                                       | | See :ref:`form-submit-log-page` for example QFQ code to display the log. |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| redirectAllMailTo                 | john@doe.com                                          | If set, redirect all QFQ generated mails (Form, Report) to the specified.  |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| sqlLogMode                        | modify                                                | | *all*: every statement will be logged - this might be a lot.             |
|                                   |                                                       | | *modifyAll*: log all statements which might change data, even if 0 rows  |
|                                   |                                                       | |    affected.                                                             |
|                                   |                                                       | | *modify*: log only statements which change data (affected rows > 0).     |
|                                   |                                                       | | *error*: log only DB errors.                                             |
|                                   |                                                       | | *none*: no SQL log at all.                                               |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| sqlLogModeAutoCron                | error                                                 | Applies only to AutoCron Jobs. For production 'error' should be fine.      |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
460
| sqlLog                            | fileadmin/protected/qfqProject/log/sql.log            | Filename to log SQL commands: relative to <site path> or absolute. If the  |
461
462
|                                   |                                                       | directory does not exist, create it.                                       |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
463
| qfqLog                            | fileadmin/protected/qfqProject/log/qfq.log            | Filename to log general QFQ events:relative to <site path> or absolute.    |
464
465
|                                   |                                                       | If the directory does not exist, create it.                                |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
466
| mailLog                           | fileadmin/protected/qfqProject/log/mail.log           | Filename to log `sendEmail` commands: relative to <site path> or absolute. |
467
468
469
470
471
|                                   |                                                       | If the directory does not exist, create it.                                |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| 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.                    |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
472
473
474
| reportMinPhpVersion               | auto                                                  | Possible values: yes|no|auto. For 'auto': If a BE User is logged in, it    |
|                                   |                                                       | becomes 'yes'. If installed PHP version is too low, report and stop QFQ.   |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
Carsten  Rose's avatar
Carsten Rose committed
475
| **Database**                                                                                                                                                           |
476
477
478
479
480
481
482
483
484
485
486
487
488
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| init                              | init=SET names utf8; SET sql_mode =                   | Global init for using the database. For 'sql_mode="NO_ENGINE_SUBSTITUTION"'|
|                                   | "NO_ENGINE_SUBSTITUTION"                              | see #7407.                                                                 |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| 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}}.    |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
Carsten  Rose's avatar
Carsten Rose committed
489
| **Security**                                                                                                                                                           |
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| escapeTypeDefault                 | m                                                     | All variables `{{...}}` get this escape class by default.                  |
|                                   |                                                       | See :ref:`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`.            |
|                                   |                                                       | :ref:`ExceptionMaxLength`.                                                 |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| securityFailedAuthDelay           | 3                                                     | If REST authorization fails, sleep 'x' seconds before answering.           |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
Carsten  Rose's avatar
Carsten Rose committed
505
| **Form-Config**                                                                                                                                                        |
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| recordLockTimeoutSeconds          | 900                                                   | Timeout for record locking. After this time, a record will be replaced.    |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| sessionTimeoutSeconds             | 1800                                                  | Timeout for FE User session. See :ref:`sessionTimeoutSeconds`              |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| 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.      |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
Carsten  Rose's avatar
Carsten Rose committed
523
| **Form-Layout**                                                                                                                                                        |
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| labelAlign                        | left                                                  | Label align (left/center/right)/ Default: left. Will be inherited to Form. |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| 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                     | col-md-12 col-lg-10                                   | The whole form will be wrapped. See :ref:`bs-custom-field-width`           |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| formBsLabelColumns                | col-md-3 col-lg-3                                     | The column get the width. See :ref:`bs-custom-field-width`                 |
+-----------------------------------+-------------------------------------------------------+                                                                            |
| formBsInputColumns                | col-md-6 col-lg-6                                     |                                                                            |
+-----------------------------------+-------------------------------------------------------+                                                                            |
| formBsNoteColumns                 | col-md-3 col-lg-3                                     |                                                                            |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| extraButtonInfoInline             | <img src="info.png">                                  | Image for :ref:`extraButtonInfo` (inline).                                 |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| extraButtonInfoBelow              | <img src="info.png">                                  | Image for :ref:`extraButtonInfo` (below).                                  |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| extraButtonInfoPosition           | below                                                 | 'auto' (default) or 'below'. See :ref:`extraButtonInfo`.                   |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| extraButtonInfoClass              | pull-right                                            | '' (default) or 'pull-right'. See :ref:`extraButtonInfo`.                  |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
Carsten  Rose's avatar
Carsten Rose committed
552
| **Form-Language**                                                                                                                                                      |
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| 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.                    |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| buttonOnChangeClass               | 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.                                              |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| showIdInFormTitle                 | 0 (off), 1 (on)                                       | Append at the form title the current record id.                            |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| cssClassColumnId                  | text-muted                                            | A column in a subrecord with the name id|ID|Id gets this class.            |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
596
597
| clearMe                           | 0 (off), 1 (on)                                       | Default to show a small 'x' in every input or textarea to clear field.     |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691

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

+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| Keyword                       | Description                                                                                                                        |
+===============================+====================================================================================================================================+
| dbNameData                    | Name of the 'data'-database. '{{dbNameData:Y}}                                                                                     |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| dbNameQfq                     | Name of the 'QFQ'-database. '{{dbNameQfq:Y}}                                                                                       |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| dbNameT3                      | Name of the 'T3'-database. '{{dbNameT3:Y}}                                                                                         |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| sitePath                      | Absolute path of the current T3 instance. '{{sitePath:Y}}                                                                          |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| extPath                       | Absolute path of the QFQ extension. '{{extPath:Y}}                                                                                 |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------+


.. _`CustomVariables`:

Custom variables
^^^^^^^^^^^^^^^^

Up to 30 custom variables can be defined in :ref:`configuration`.

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

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

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

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

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

.. _`fillStoreSystemBySql`:

Fill STORE_SYSTEM by SQL
^^^^^^^^^^^^^^^^^^^^^^^^

A specified SELECT statement in :ref:`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
**added** to the existing STORE_SYSTEM. Existing variables will be overwritten. Be careful not to overwrite system values.

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

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

.. _`periodId`:

periodId
""""""""

This is

* a usecase, implemented via :ref:`fillStoreSystemBySql`,
* a way to access `Period.id` with respect to the current period (the period itself is custom defined).

After a full QFQ installation:

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

Websites, delivering semester data, school year schedules, or any other type or periods, often need an index to the
*current* period.

In :ref:`configuration`: ::

  fillStoreSystemBySql1: SELECT id AS periodId FROM Period WHERE start<=NOW() ORDER BY start DESC LIMIT 1

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('p:{{pageAlias:T}}&periodId=', {{periodId:SY0}}-1, '|Next') AS _page, ' ', name, ' ',
    CONCAT('p:{{pageAlias: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`:

DB USER privileges
^^^^^^^^^^^^^^^^^^

692
693
694
695
The specified DB User needs privileges

  * to the QFQ database of at least: SELECT / INSERT / UPDATE / DELETE / SHOW.
  * to the Typo3 database of at least table `tt_content` with SELECT.
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729

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 access to the Typo3 Database with at least SELECT / INSERT / UPDATE / DELETE.



.. _`ExceptionMaxLength`:

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

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


.. _`sessionTimeoutSeconds`:

FE-User: Session timeout seconds
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

There is no timeout for website users who are not logged in (but typically those users don't have access to protected content).

For logged in users, the default timeout is the php.ini settings for `session.cookie_lifetime` and `session.gc_maxlifetime`
(minimum of both). These timeout only affects QFQ related content and can be
specified a) globally (QFQ configuration) and b) specific per Form.

The maximum timeout depends on the minimal value of php.ini `session.cookie_lifetime` and `session.gc_maxlifetime`.
Specifying a higher value produces an error in the front end.

Every access to QFQ related content resets the timeout.

After FE login, the next access to QFQ related content starts the timeout counter.
730
731
732
733
734
735
736
737
738
739


.. _`removeFormBackupCron`:

Cron Job: Remove Form Backup Files
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The following cron job may be used to automatically remove form backup files (see :ref:`formAsFile`) which are older than 31 days. Be sure to adjust the path accordingly: ::

  0 19 * * * find /var/www/html/fileadmin/protected/qfqProject/form/.backup/ -type f -mtime +31  -exec rm {} \;