QuickFormQuery.php 14.5 KB
Newer Older
1
2
3
4
5
6
7
8
<?php
/**
 * Created by PhpStorm.
 * User: ep
 * Date: 12/23/15
 * Time: 6:33 PM
 */

Carsten  Rose's avatar
Carsten Rose committed
9

10
11
namespace qfq;

Carsten  Rose's avatar
Carsten Rose committed
12
use qfq;
13
14
15
16
17
18
19
20
21

//use qfq\Report;

//use qfq\BuildFormPlain;
//use qfq\BuildFormTable;
//use qfq\BuildFormBootstrap;
//use qfq\UserException;
//use qfq\CodeException;
//use qfq\DbException;
22
//use qfq\helper;
23
//use qfq\Store;
Carsten  Rose's avatar
Carsten Rose committed
24

Carsten  Rose's avatar
Carsten Rose committed
25

26
require_once(__DIR__ . '/../qfq/store/Store.php');
Carsten  Rose's avatar
Carsten Rose committed
27
require_once(__DIR__ . '/../qfq/Constants.php');
28
require_once(__DIR__ . '/../qfq/Save.php');
Carsten  Rose's avatar
Carsten Rose committed
29
require_once(__DIR__ . '/../qfq/helper/KeyValueStringParser.php');
30
require_once(__DIR__ . '/../qfq/helper/HelperFormElement.php');
Carsten  Rose's avatar
Carsten Rose committed
31
require_once(__DIR__ . '/../qfq/exceptions/UserException.php');
32
33
require_once(__DIR__ . '/../qfq/exceptions/CodeException.php');
require_once(__DIR__ . '/../qfq/exceptions/DbException.php');
34
require_once(__DIR__ . '/../qfq/exceptions/ErrorHandler.php');
35
require_once(__DIR__ . '/../qfq/Database.php');
Carsten  Rose's avatar
Carsten Rose committed
36
require_once(__DIR__ . '/../qfq/Evaluate.php');
37
38
39
require_once(__DIR__ . '/../qfq/BuildFormPlain.php');
require_once(__DIR__ . '/../qfq/BuildFormTable.php');
require_once(__DIR__ . '/../qfq/BuildFormBootstrap.php');
40
require_once(__DIR__ . '/../qfq/report/Report.php');
41
require_once(__DIR__ . '/../qfq/BodytextParser.php');
42

43
44
45
46
47
48
49
50
51
52
53
54
/*
 * Form will be called
 * a) with a SIP identifier, or
 * b) without a SIP identifier (form setting has to allow this) and will create on the fly a new SIP.
 *
 * The SIP-Store stores:
 *  form=<formname>
 *  r=<record id>  (table.id for a single record form)
 *  keySemId,keySemIduser
 *  <further individual variables>
 */

Carsten  Rose's avatar
Carsten Rose committed
55
/**
56
 * Class Qfq
Carsten  Rose's avatar
Carsten Rose committed
57
58
 * @package qfq
 */
59
class QuickFormQuery {
60
    /**
61
     * @var \qfq\Store instantiated class
62
     */
Carsten  Rose's avatar
Carsten Rose committed
63
    protected $store = null;
64
65
66
    /**
     * @var Database instantiated class
     */
67
    protected $db = null;
68
69
70
71
    /**
     * @var Evaluate instantiated class
     */
    protected $eval = null;
72
73
74
75
76
77
78
    protected $formSpec = array();
    protected $feSpecAction = array();  // Form Definition: copy of the loaded form
    protected $feSpecNative = array(); // FormEelement Definition: all formElement.class='action' of the loaded form
    /**
     * @var array
     */
    private $t3data = array(); // FormEelement Definition: all formElement.class='native' of the loaded form
79

80
81
    private $phpUnit = false;

82
83
84
85
86
87
88
89
90
91
92
    /*
     * TODO:
     *  Preparation: setup logging, database access, record locking
     *  fill stores
     *  Check permission_create / permission_update
     *  Multi: iterate over all records, Single: activate record
     *      Check mode: Load | Save
     *      doActions 'Before'
     *      Do all FormElements
     *      doActions 'After'
     */
93

94
95
96
97
98
    /**
     * Construct the Form Class and Store too. This is the base initialization moment.
     *
     * As a result of instantiating of Form, the class Store will initially called the first time and therefore instantiated automatically.
     * Store might throw an exception, in case the URL-passed SIP is invalid.
99
     *
100
     * @param string $bodytext
101
     */
102
103
    public function __construct(array $t3data = array(), $phpUnit = false) {

104
105
        $this->phpUnit = $phpUnit;

106
        mb_internal_encoding("UTF-8");
107

Carsten  Rose's avatar
Carsten Rose committed
108
109
110
111
112
113
114
115
116
117
        // session.cache_expire
        // session.cookie_lifetime
        // session.gc_maxlifetime

//        $arr1['sessionname'] =   session_name();
//        $arr1['session.auto_start']  = ini_get('session.auto_start');
//        $arr1['session.gc_maxlifetime']  = ini_get('session.gc_maxlifetime');
//        $arr1['session.cookie_lifetime']  = ini_get('session.cookie_lifetime');
//        $arr1['session.name']  = ini_get('session.name');

118
119
120
        // Refresh the session even if no new data saved.
        $_SESSION['LAST_ACTIVITY'] = time();

121
        set_error_handler("\\qfq\\ErrorHandler::exception_error_handler");
122

123
124
125
126
127
        if (!isset($t3data['bodytext']))
            $t3data['bodytext'] = '';
        if (!isset($t3data['uid']))
            $t3data['uid'] = 0;

128
129
130
        $btp = new BodytextParser();
        $t3data['bodytext'] = $btp->process($t3data['bodytext']);

131
132
        $this->t3data = $t3data;

133
134
135
        $bodytext = $this->t3data['bodytext'];

        $this->store = Store::getInstance($bodytext, $phpUnit);
136
        $this->store->setVar(TYPO3_TT_CONTENT_UID, $t3data['uid'], STORE_TYPO3);
137
138
        $this->db = new Database();
        $this->eval = new Evaluate($this->store, $this->db);
Carsten  Rose's avatar
Carsten Rose committed
139
140
    }

141
    /**
142
143
     * Returns the defined forwardMode and set, if necessary, $forwardPage
     *
144
145
146
147
148
149
150
151
     * @param $forwardPage
     * @return mixed
     */
    public function getForwardMode(&$forwardPage) {
        $forwardPage = $this->formSpec['forwardPage'];
        return $this->formSpec['forwardMode'];
    }

152
    /**
153
154
     * Main entrypoint for display content: form or report
     *
155
     * @return string
Carsten  Rose's avatar
Carsten Rose committed
156
     */
157
    public function process() {
158

159
        $html = $this->doForm();
160
        $html .= $this->doReport();
Carsten  Rose's avatar
Carsten Rose committed
161

162
163
164
165
        $class = $this->store->getVar(SYSTEM_CSS_CLASS_QFQ_CONTAINER, STORE_SYSTEM);
        if ($class)
            $html = Support::wrapTag("<div class='$class'>", $html);

166
        return $html;
167
168
    }

169
170
    /**
     * Process form (load or save) if a formname is found.
171
     *
172
173
174
175
176
177
     * @return string
     * @throws CodeException
     * @throws UserException
     */
    private function doForm() {
        $html = '';
Carsten  Rose's avatar
Carsten Rose committed
178
        $foundInStore = '';
179
180
181
182

        // Form action: load or save?
        $mode = isset($_SERVER['REQUEST_METHOD']) && $_SERVER['REQUEST_METHOD'] === 'POST' ? FORM_SAVE : FORM_LOAD;

Carsten  Rose's avatar
Carsten Rose committed
183
        $formName = $this->loadFormSpecification($mode, $foundInStore);
184
185
186
        if ($formName === false)
            return '';

Carsten  Rose's avatar
Carsten Rose committed
187
        $sipFound = $this->validateForm($foundInStore);
188
189
190
191
192
193
194
        if (!$sipFound) {
            $this->store->createSipAfterFormLoad($formName);
        }
        $this->store->fillStoreTableDefaultColumnType($this->formSpec['tableName']);

        switch ($mode) {
            case FORM_LOAD:
195
196
197
198
199
200
201
202
203
204
205
206
207
208
                switch ($this->formSpec['render']) {
                    case 'plain':
                        $build = new BuildFormPlain($this->formSpec, $this->feSpecAction, $this->feSpecNative);
                        break;
                    case 'table':
                        $build = new BuildFormTable($this->formSpec, $this->feSpecAction, $this->feSpecNative);
                        break;
                    case 'bootstrap':
                        $build = new BuildFormBootstrap($this->formSpec, $this->feSpecAction, $this->feSpecNative);
                        break;
                    default:
                        throw new CodeException("This statement should never be reached", ERROR_CODE_SHOULD_NOT_HAPPEN);
                }
                $html = $build->process();
209
210
211
212
213
214
215
216
217
218
219
220
                break;
            case FORM_SAVE:
                $save = new Save($this->formSpec, $this->feSpecAction, $this->feSpecNative);
                $save->process();
                break;
            default:
                throw new CodeException("This statement should never be reached", ERROR_CODE_SHOULD_NOT_HAPPEN);
        }
        return $html;

    }

221
    /**
222
     * Load form. Evaluates form. Load FormElements.
223
224
225
226
227
     *
     * Loaded Form is in  $this->formSpec
     * Loaded 'action' FormElements are in $this->feSpecAction
     * Loaded 'native' FormElements are in $this->feSpecNative
     *
228
     * @param string $mode FORM_LOAD|FORM_SAVE
229
     * @return string|bool if found the formName, else 'false'.
230
     * @throws DbException
Carsten  Rose's avatar
Carsten Rose committed
231
     * @throws UserException. F.e.: if the form is loaded via Client, but permission is set to SIP.
232
     */
Carsten  Rose's avatar
Carsten Rose committed
233
    private function loadFormSpecification($mode, &$foundInStore = '') {
Carsten  Rose's avatar
Carsten Rose committed
234

235
        // formName
Carsten  Rose's avatar
Carsten Rose committed
236
        if (false === ($formName = $this->getFormName($mode, $foundInStore))) {
237
238
            return false;
        }
239
        $this->store->setVar(SYSTEM_FORM, $formName, STORE_SYSTEM);
Carsten  Rose's avatar
Carsten Rose committed
240

241
242
243
        // Load form
        $form = $this->db->sql("SELECT * FROM Form AS f WHERE f.name LIKE ? AND f.deleted='no'", ROW_EXPECT_1,
            [$formName], 'Form not found or multiple forms with the same name.');
244
245

        $this->formSpec = $this->eval->parseArray($form);
246
        HelperFormElement::explodeParameter($this->formSpec);
247

Carsten  Rose's avatar
Carsten Rose committed
248
        // Clear
249
250
        $this->store->setVar(SYSTEM_FORM_ELEMENT, '', STORE_SYSTEM);

251
        // FE: Action
252
253
        $this->feSpecAction = $this->eval->parseArray($this->db->sql(SQL_FORM_ELEMENT_ALL_CONTAINER, ROW_REGULAR,
            ['no', $this->formSpec["id"], 'action']));
254
        HelperFormElement::explodeParameterInArrayElements($this->feSpecAction);
255
256

        // FE: Native & Container
257
258
259
        // "SELECT *, ? AS 'nestedInFieldSet' FROM FormElement AS fe WHERE fe.formId = ? AND fe.deleted = 'no' AND FIND_IN_SET(fe.class, ? ) AND fe.feIdContainer = ? AND fe.enabled='yes' ORDER BY fe.ord, fe.id";
        switch ($mode) {
            case FORM_LOAD:
260
261
                $this->feSpecNative = $this->db->sql(SQL_FORM_ELEMENT_SPECIFIC_CONTAINER, ROW_REGULAR,
                    ['no', $this->formSpec["id"], 'native,container', 0]);
262
263
264
                break;

            case FORM_SAVE:
265
266
                $this->feSpecNative = $this->db->sql(SQL_FORM_ELEMENT_ALL_CONTAINER, ROW_REGULAR,
                    ['no', $this->formSpec["id"], 'native']);
267
268
269
270
271
                break;

            default:
        }

272
        HelperFormElement::explodeParameterInArrayElements($this->feSpecNative);
273
274

        return $formName;
Carsten  Rose's avatar
Carsten Rose committed
275
276
    }

Carsten  Rose's avatar
Carsten Rose committed
277
    /**
278
279
     * Get the formName from STORE_TYPO3 (bodytext), STORE_SIP or by STORE_CLIENT (URL).
     *
280
281
282
283
284
285
286
287
288
289
290
291
     * FORM_LOAD:
     *   Specified in T3 body text with form=<formname>            Returned Store:Typo3
     *   Specified in T3 body text with form={{form}} ':FSRD'      Returned Store:SIP
     *   Specified in T3 body text with form={{form:C:ALNUMX}}     Returned Store:Client
     *   Specified in T3 body text with form={{SELECT registrationFormName FROM Conference WHERE id={{conferenceId:S0}} }}
     *   Specified in T3 body text with form={{SELECT registrationFormName FROM Conference WHERE id={{conferenceId:C0:DIGIT}} }}
     *   Specified in SIP
     *
     * FORM_SAVE:
     *   Specified in SIP
     *
     *
Carsten  Rose's avatar
Carsten Rose committed
292
293
     * @param $mode
     * @param string $foundInStore
294
     * @return bool|string Formname (Form.name) or FALSE, if no formname found.
Carsten  Rose's avatar
Carsten Rose committed
295
296
     */

Carsten  Rose's avatar
Carsten Rose committed
297
    private function getFormName($mode, &$foundInStore = '') {
298
        $dummy = array();
Carsten  Rose's avatar
Carsten Rose committed
299

Carsten  Rose's avatar
Carsten Rose committed
300
        $store = ($mode === FORM_SAVE) ? STORE_SIP : STORE_TYPO3;
301
302
303
        $storeFormName = $this->store->getVar(SIP_FORM, $store, '', $foundInStore);

        $formName = $this->eval->parse($storeFormName, 0, $dummy, $foundInStore);
Carsten  Rose's avatar
Carsten Rose committed
304

305
306
307
308
309
310
311
312
        // If the formname is '': no formname name.
        if ($formName === '')
            return false;

        // If the formname is surrounded by single ticks: the token (typically 'form') has not been replaced by a value.
        if ($formName[0] === "'" && $formName[strlen($formName) - 1] === "'") {
            return false;
        }
313

314
        return $formName;
315
    }
Carsten  Rose's avatar
Carsten Rose committed
316

317
    /**
Carsten  Rose's avatar
Carsten Rose committed
318
     * Check if loading of the given form is permitted. If not, throw an exception.
319
     *
Carsten  Rose's avatar
Carsten Rose committed
320
     * @param $foundInStore
321
322
323
324
     * @return bool - 'true' if SIP exists, else 'false'
     * @throws CodeException
     * @throws UserException
     */
Carsten  Rose's avatar
Carsten Rose committed
325
    private function validateForm($formNameFoundInStore) {
326
327

        // Retrieve record_id either from SIP (prefered) or via URL
Carsten  Rose's avatar
Carsten Rose committed
328
        $r = $this->store->getVar(SIP_RECORD_ID, STORE_SIP . STORE_CLIENT, '', $recordIdFoundInStore);
329

Carsten  Rose's avatar
Carsten Rose committed
330
        // If there is a record_id>0: EDIT else NEW: 'sip','logged_in','logged_out','always','never'
331
        $permitMode = ($r > 0) ? $this->formSpec['permitEdit'] : $this->formSpec['permitNew'];
332
333
334
335
336

        $feUserLoggedIn = isset($GLOBALS["TSFE"]->fe_user->user["uid"]) && $GLOBALS["TSFE"]->fe_user->user["uid"] > 0;

        $sipFound = $this->store->getVar(SIP_SIP, STORE_SIP) !== false;

Carsten  Rose's avatar
Carsten Rose committed
337
338
        if ($sipFound) {
            if (($formNameFoundInStore === STORE_CLIENT) || ($recordIdFoundInStore === STORE_CLIENT)) {
339
                throw new UserException("SIP exist but FORM or RECORD_ID are given by CLIENT.", ERROR_SIP_EXIST_BUT_OTHER_PARAM_GIVEN_BY_CLIENT);
Carsten  Rose's avatar
Carsten Rose committed
340
341
342
            }
        }

343
        switch ($permitMode) {
344
            case  FORM_PERMISSION_SIP:
Carsten  Rose's avatar
Carsten Rose committed
345
                if (!$sipFound || $formNameFoundInStore !== STORE_SIP || $recordIdFoundInStore !== STORE_SIP) {
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
                    throw new UserException("SIP Parameter needed for this form.", ERROR_SIP_NEEDED_FOR_THIS_FORM);
                }
                break;
            case  FORM_PERMISSION_LOGGED_IN:
                if (!$feUserLoggedIn) {
                    throw new UserException("User not logged in.", ERROR_USER_NOT_LOGGED_IN);
                }
                break;
            case FORM_PERMISSION_LOGGED_OUT:
                if ($feUserLoggedIn) {
                    throw new UserException("User logged in.", ERROR_USER_LOGGED_IN);
                }
                break;
            case FORM_PERMISSION_ALWAYS:
                break;
            case FORM_PERMISSION_NEVER:
                throw new UserException("Loading form forbidden.", ERROR_FORM_FORBIDDEN);
            default:
364
                throw new CodeException("Unknown permission mode: '" . $permitMode . "'", ERROR_FORM_UNKNOWN_PERMISSION_MODE);
365
        }
Carsten  Rose's avatar
Carsten Rose committed
366

Carsten  Rose's avatar
Carsten Rose committed
367
        // Form Definition valid?
368
        if ($this->formSpec['multiMode'] !== 'none' && $this->formSpec['multiSql'] === '') {
Carsten  Rose's avatar
Carsten Rose committed
369
370
371
            throw new UserException("MultiMode selected, but MultiSQL missing", ERROR_MULTI_SQL_MISSING);
        }

372
        return $sipFound;
373
    }
Carsten  Rose's avatar
Carsten Rose committed
374

375
    /**
376
377
     * Process the SQL Queries from bodytext. Return the output.
     *
378
379
     * @return string
     */
380
    private function doReport() {
381
        $report = new Report($this->t3data, $this->store->getVar(SYSTEM_SESSION_NAME, STORE_SYSTEM), $this->phpUnit);
382

383
        $html = $report->process();
384
385
386
387
388

        return $html;

    }

389
    /**
390
391
     * Save the current form.
     *
392
393
394
395
396
397
398
399
400
     * @return string
     */
    public function saveForm() {

        $html = $this->doForm();

        return $html;
    }

401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
    /**
     * Delete a record (tablename and recordid are given) or process a 'delete form'
     *
     * @throws CodeException
     * @throws DbException
     * @throws UserException
     */
    public function delete() {

        #TODO: implement 'delete form'

        // simple delete: table and recordId are given
        $recordId = $this->store->getVar(SIP_RECORD_ID, STORE_SIP);
        $table = $this->store->getVar(SIP_TABLE, STORE_SIP);

Carsten  Rose's avatar
Carsten Rose committed
416
        if ($recordId === false || $recordId < 1 || $table === false || $table === '') {
417
418
419
            throw new UserException("Invalid or missing parameter: recordId=$recordId, table=$table", ERROR_INVALID_OR_MISSING_PARAMETER);
        }

Carsten  Rose's avatar
Carsten Rose committed
420
        $this->db->sql("DELETE FROM $table WHERE id = ? LIMIT 1", ROW_REGULAR, [$recordId]);
421
422
    }

423
}