FormAction.php 17.4 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
<?php
/**
 * Created by PhpStorm.
 * User: crose
 * Date: 5/29/16
 * Time: 5:24 PM
 */

namespace qfq;

require_once(__DIR__ . '/../Constants.php');
require_once(__DIR__ . '/../Database.php');
require_once(__DIR__ . '/../store/Store.php');
require_once(__DIR__ . '/../Evaluate.php');
15
require_once(__DIR__ . '/../report/Sendmail.php');
16
17
18
19
20

/**
 * Class formAction
 * @package qfq
 */
21
class FormAction {
22
23

//    private $feSpecNative = array(); // copy of all formElement.class='native' of the loaded form
24
25
26
27
28
    /**
     * @var Evaluate instantiated class
     */
    protected $evaluate = null;  // copy of the loaded form
    private $formSpec = array();
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
    private $primaryTableName = '';
    /**
     * @var Database
     */
    private $db = null;
    /**
     * @var Store
     */
    private $store = null;

    /**
     * @param array $formSpec
     * @param Database $db
     * @param bool|false $phpUnit
     */
    public function __construct(array $formSpec, Database $db, $phpUnit = false) {
        $this->formSpec = $formSpec;
46
        $this->primaryTableName = Support::setIfNotSet($formSpec, F_TABLE_NAME);
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

        $this->db = $db;

        $this->store = Store::getInstance('', $phpUnit);

        $this->evaluate = new Evaluate($this->store, $this->db);

    }

    /**
     * @param integer $recordId
     * @param array $feSpecAction
     * @param string $feTypeList
     *         On FormLoad: FE_TYPE_BEFORE_LOAD, FE_TYPE_AFTER_LOAD
     *         Before Save: FE_TYPE_BEFORE_SAVE, FE_TYPE_BEFORE_INSERT, FE_TYPE_BEFORE_UPDATE, FE_TYPE_BEFORE_DELETE
     *         After Save: FE_TYPE_AFTER_SAVE, FE_TYPE_AFTER_INSERT, FE_TYPE_AFTER_UPDATE, FE_TYPE_AFTER_DELETE
63
     * @return bool: true if there are potential changes on the DB like fired SQL statements, else false.
64
65
66
67
68
69
     * @throws CodeException
     * @throws DbException
     * @throws UserFormException
     */
    public function elements($recordId, array $feSpecAction, $feTypeList) {

70
71
        $flagModified = false;

72
73
74
        // Iterate over all Action FormElements
        foreach ($feSpecAction as $fe) {

75
76
            $fe = $this->initActionFormElement($fe);

77
            // Only process FE elements of types listed in $feTypeList. Skip all other
78
79
80
81
            if (false === Support::findInSet($fe[FE_TYPE], $feTypeList)) {
                continue;
            }

82
83
84
            // Preparation for Log, Debug
            $this->store->setVar(SYSTEM_FORM_ELEMENT, Logger::formatFormElementName($fe), STORE_SYSTEM);

85
            if ($fe[FE_TYPE] !== FE_TYPE_BEFORE_LOAD && $fe[FE_TYPE] !== FE_TYPE_AFTER_LOAD) {
86
                // Always work on recent data: previous actions might have modified the data.
87
88
89
                $this->fillStoreRecord($this->primaryTableName, $recordId);
            }

90
91
92
93
            if (!$this->checkRequiredList($fe)) {
                continue;
            }

94
95
96
97
98
            if ($fe[FE_TYPE] === FE_TYPE_SENDMAIL) {
                $this->sendMail($fe);
                //no further processing of current element necessary.
                continue;
            }
99
100
101
102

            $this->validate($fe);

            $this->doSlave($fe, $recordId);
103
104

            $flagModified = true;
105
        }
106
107

        return $flagModified;
108
109
    }

110
    /**
111
     * Set all necessary keys - subsequent 'isset()' are not necessary anymore.
112
113
114
115
116
     *
     * @param array $fe
     * @return array
     */
    private function initActionFormElement(array $fe) {
117
118
119
120
121

        $list = [FE_TYPE, FE_SLAVE_ID, FE_SQL_VALIDATE, FE_SQL_INSERT, FE_SQL_UPDATE, FE_SQL_DELETE, FE_EXPECT_RECORDS,
            FE_REQUIRED_LIST, FE_MESSAGE_FAIL, FE_SENDMAIL_TO, FE_SENDMAIL_CC, FE_SENDMAIL_BCC, FE_SENDMAIL_FROM, FE_SENDMAIL_SUBJECT, FE_SENDMAIL_REPLY_TO,
            FE_SENDMAIL_FLAG_AUTO_SUBMIT, FE_SENDMAIL_GR_ID, FE_SENDMAIL_X_ID];

122
123
124
        foreach ($list as $key) {
            Support::setIfNotSet($fe, $key);
        }
125

126
127
128
        return $fe;
    }

129
    /**
130
131
     * @param $table
     * @param $recordId
132
     * @throws CodeException
133
     * @throws DbException
134
135
     * @throws UserFormException
     */
136
    private function fillStoreRecord($table, $recordId) {
137

138
139
        if (!is_string($table) || $table === '') {
            throw new UserFormException("");
140
        }
141
142
143
        if ($recordId !== false && $recordId > 0) {
            $record = $this->db->sql("SELECT * FROM $table WHERE id = ?", ROW_EXPECT_1, [$recordId]);
            $this->store->setVarArray($record, STORE_RECORD, true);
144
        }
145
    }
146

147
148
149
150
151
152
153
154
155
    /**
     * Process all FormElements given in the `requiredList` identified be their name.
     * If none is empty in STORE_FORM return true, else false.
     * If none FormElement is specified, return true.
     *
     * @param array $fe
     * @return bool  true if none FE is specified or all specified are non empty.
     */
    private function checkRequiredList(array $fe) {
156

157
158
        if (!isset($fe[FE_REQUIRED_LIST]) || $fe[FE_REQUIRED_LIST] === '') {
            return true;
159
160
        }

161
162
163
164
165
166
167
168
169
        $arr = explode(',', $fe[FE_REQUIRED_LIST]);
        foreach ($arr as $key) {

            $key = trim($key);
            $val = $this->store->getVar($key, STORE_FORM);

            if ($val === false || $val === '' || $val === '0') {
                return false;
            }
170
171
        }

172
        return true;
173
174
    }

175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
    /**
     * @param array $feSpecAction
     */
    private function sendMail(array $feSpecAction) {

        $mail[SENDMAIL_IDX_RECEIVER] = $this->evaluate->parse($feSpecAction[FE_SENDMAIL_TO]);
        $mail[SENDMAIL_IDX_SENDER] = $this->evaluate->parse($feSpecAction[FE_SENDMAIL_FROM]);
        $mail[SENDMAIL_IDX_SUBJECT] = $this->evaluate->parse($feSpecAction[FE_SENDMAIL_SUBJECT]);
        $mail[SENDMAIL_IDX_BODY] = $this->evaluate->parse($feSpecAction[FE_VALUE]);
        $mail[SENDMAIL_IDX_REPLY_TO] = $this->evaluate->parse($feSpecAction[FE_SENDMAIL_REPLY_TO]);
        $mail[SENDMAIL_IDX_FLAG_AUTO_SUBMIT] = $this->evaluate->parse($feSpecAction[FE_SENDMAIL_FLAG_AUTO_SUBMIT]) === 'on' ? 'on' : 'off';
        $mail[SENDMAIL_IDX_GR_ID] = $this->evaluate->parse($feSpecAction[FE_SENDMAIL_GR_ID]);
        $mail[SENDMAIL_IDX_X_ID] = $this->evaluate->parse($feSpecAction[FE_SENDMAIL_X_ID]);
        $mail[SENDMAIL_IDX_RECEIVER_CC] = $this->evaluate->parse($feSpecAction[FE_SENDMAIL_CC]);
        $mail[SENDMAIL_IDX_RECEIVER_BCC] = $this->evaluate->parse($feSpecAction[FE_SENDMAIL_BCC]);
        $mail[SENDMAIL_IDX_SRC] = "FormId: " . $feSpecAction['formId'] . ", FormElementId: " . $feSpecAction['id'];

        // Mail: send
        new Sendmail($mail);
    }

196
197
198
199
    /**
     * If there is a query defined in fe.parameter.FE_SQL_VALIDATE: fire them.
     * Count the selected records and compare them with fe.parameter.FE_EXPECT_RECORDS.
     * If match: everything is fine, do nothing.
200
     * Else throw UserFormException with error message of fe.parameter.FE_MESSAGE_FAIL
201
202
203
204
205
206
207
     *
     * @param array $fe
     * @throws UserFormException
     */
    private function validate(array $fe) {

        // Is there something to check?
208
        if ($fe[FE_SQL_VALIDATE] === '') {
209
210
211
            return;
        }

212
        $expect = $this->evaluate->parse($fe[FE_EXPECT_RECORDS]);
213

214
        if ($fe[FE_MESSAGE_FAIL] === '') {
215
216
217
218
219
220
221
222
223
            throw new UserFormException("Missing error message. Column: " . FE_MESSAGE_FAIL, ERROR_MISSING_MESSAGE_FAIL);
        }

        // Do the check
        $result = $this->evaluate->parse($fe[FE_SQL_VALIDATE]);
        if (!is_array($result)) {
            throw new UserFormException("Expected an array for '" . FE_SQL_VALIDATE . "', got a scalar. Please check for {{!...", ERROR_EXPECTED_ARRAY);
        }

224
225
226
227
228
229
        // If there is at least one record count given, who matches: return 'check succeeded'
        $countRecordsArr = explode(',', $expect);
        foreach ($countRecordsArr AS $count) {
            if (count($result) == $count) {
                return; // check succesfully passed
            }
230
231
        }

232
        $msg = $this->evaluate->parse($fe[FE_MESSAGE_FAIL]); // Replace possible dynamic parts
233
234
235
236
237

        // Throw user defineable error message
        throw new UserFormException($msg, ERROR_REPORT_FAILED_ACTION);
    }

238
239
240
241
242
243
244
245
246
247
248
    /**
     * Create the slave record. First try to evaluate a slaveId. Depending if the slaveId > 0 choose `sqlUpdate` or `sqlInsert`
     *
     * @param array $fe
     * @return int
     * @throws CodeException
     * @throws UserFormException
     */
    private function doSlave(array $fe, $recordId) {

        // Get the slaveId
249
        $slaveId = $this->evaluate->parse($fe[FE_SLAVE_ID]);
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265

        if ($slaveId === '' && $fe[FE_NAME] !== '') {
            // if the current action element has the same name as a real master record column: take that value as an id
            $slaveId = $this->store->getVar($fe[FE_NAME], STORE_RECORD);
        }

        if ($slaveId === '' || $slaveId === false) {
            $slaveId = 0;
        }

        // Store the slaveId: it's used and replaced in the update statement.
        $this->store->setVar(ACTION_KEYWORD_SLAVE_ID, $slaveId, STORE_VAR, true);

        // Fire slave query
        if ($slaveId == 0) {
            $slaveId = $this->evaluate->parse($fe[FE_SQL_INSERT]);
266
267
            // Store the slaveId: it's used and replaced in the update statement.
            $this->store->setVar(ACTION_KEYWORD_SLAVE_ID, $slaveId, STORE_VAR, true);
268
269
270
271
272
273
        } else {
            $this->evaluate->parse($fe[FE_SQL_UPDATE]);
        }

        // Check if there is a column with the same name as the 'action'-FormElement.
        if (false !== $this->store->getVar($fe[FE_NAME], STORE_RECORD)) {
274
            // After an insert or update, propagate the (new) slave id to the master record.
275
276
277
            $this->db->sql("UPDATE " . $this->primaryTableName . " SET " . $fe[FE_NAME] . " = $slaveId WHERE id = ? LIMIT 1", ROW_REGULAR, [$recordId]);
        }

278
        // If given: fire a delete query
279
280
        $this->evaluate->parse($fe[FE_SQL_DELETE]);

281
282
        return $slaveId;
    }
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
}
//
///********************************************************
// * doAddNUpdate
// * RC: TRUE     ok
// * FALSE,$err bei Fehler
// *********************************************************/
//function doAddNUpdate($formId, $masterId, $tableName, &$err) {
//    global $FeId;
//
//    if ($this->DebugLevel > 3) t3lib_div::debug("doAddNUpdate");
//
//    // Selektiere alle 'addNupdate'-DS des aktuellen Formulars
//    $sql = "SELECT * FROM form_element WHERE form_id=" . $formId . " AND typ='addNupdate' AND active='Yes' ORDER BY ord";
//    if ($this->DebugLevel > 3) t3lib_div::debug($sql);
//    if (!($formDs = mysql(MATH_DB_NAME, $sql))) return ($this->buildMySQLErrMsg($err, $sql, __FILE__, __LINE__));
//
//    // Falls nix zu tun ist (kein DS vorhanden), gleich zurueck.
//    if (mysql_num_rows($formDs) == 0) return (TRUE);
//
//    // Durchlaufe alle 'addNupdate' DS
//    while ($formularDs = mysql_fetch_array($formDs, MYSQL_ASSOC)) {
//
//        $FeId = $formularDs['id']; // Just for logging
//
//        if ($this->DebugLevel > 3) t3lib_div::debug($formularDs);
//
//        // Lese den zuvor gespeicherten Master DS
//        // Der Master DS sollte nach jedem AddNUpdate neu gelesen werden, evtl. wurde etwas eingetragen
//
//        $masterDs = $this->doQuerySingle("SELECT * FROM " . $tableName . " WHERE id=" . $masterId, $err);
//        if ($err) return (FALSE);
//
//        // Check ob addNUpadte ueberhaupt ausgefuehrt werden soll: Ist 'param' gesetzt ?
//        //	 JA: dann auswerten ob die in 'param' aufgefuehrten Formularfelder gefuellt sind
//        //			 Wenn nein, naechsten addNUpdate DS bearbeiten
//        //	 NEIN: normal weiter machen
//        if ($formularDs["param"]) {
//            $arr = explode(",", $formularDs["param"]);
//            $t = TRUE;
//            foreach ($arr as $elem) {
//                if ($GLOBALS[HTTP_POST_VARS][FRM . $elem]) {
//                    $t = FALSE;
//                    break; //foreach
//                }
//            }
//            if ($t) {
//                if ($this->DebugLevel > 3) t3lib_div::debug("doAddNUpdate() nicht ausfuehren, da param gesetzt ist und angegebene Felder leer sind.");
//                continue; //while
//            }
//        }
//
//        # Falls in 'value' ein select Statement angegeben ist, dieses ausführen.
//        # Es sollte 0 oder 1 DS gefunden werden.
//        # Die Spalte 'id' muss vorhanden sein und diese die slaveID angeben.
//        if ($formularDs["value"]) {
//            $sql = $this->substituteAssoc($formularDs["value"], $masterDs);
//            $slaveDs = $this->doQuerySingle($sql, $err, EMPTY_IS_OK);
//            $slaveId = $slaveDs["id"];
//        } else {
//
//            // Name des aktuellen addNupdate	Formularelementes, kann gleichzeitig eine ID im masterDs auf eine slaveDS sein
//            // Ist so eine ID>0 muss ein Update durchgefuehrt werden, sonst ein insert.
//            // Bsp: Formular 'publikation_mit_upload_new' - zur aktuellen Publikation wird ein Notiz DS mit dem Dateinamen der Publikation angelegt.
//            if ($masterDs[$formularDs["name"]])
//                $slaveId = $masterDs[$formularDs["name"]];
//            else
//                $slaveId = $GLOBALS[HTTP_POST_VARS][FRM . $formularDs["name"]]; // einige spezielle doAddNUpdate benutzen temporaere Variablen (z.B. Formular publikation_mit_upload: my_pid
//        }
//
//        if ($slaveId > 0) {
//
//            //			if($GLOBALS[HTTP_POST_VARS][FRM."id".$post]>0) { // Es existiert ein zugehoeriger DS (=Slave)
//
//            // Check ob ein Update Statement existiert
//            if (!$formularDs["sql_update"])
//                continue;
//
//            // Ersetze Variablen in dem SQL update Statement.
//            $sql = $this->substituteAssoc($formularDs["sql_update"], $masterDs);
//
//            if ($this->DebugLevel > 0) echo("doAddNUpdate(update):" . $sql . "<BR>");
//
//            // Fuehre das Update auf den Slave DS aus.
//            if ($this->DebugLevel > 3) t3lib_div::debug($sql);
//            if (!($res = $this->doSQL(MATH_DB_NAME, $sql . " "))) return ($this->buildMySQLErrMsg($err, $sql . " ", __FILE__, __LINE__, $formularDs));
//
//        } else {    // Es existiert noch kein zugehoeriger DS (=Slave)
//
//            // Check ob ein Insert Statement existiert
//            if (!$formularDs["sqlq"])
//                continue;
//
//            // Ersetze Variablen in dem SQL insert Statement.
//            $sql = $this->substituteAssoc($formularDs["sqlq"], $masterDs);
//
//            // Fuehre das Update auf den Slave DS aus.
//            if ($this->DebugLevel > 1) t3lib_div::debug($sql);
//            if (!($res = $this->doSQL(MATH_DB_NAME, $sql))) {
//                $this->buildMySQLErrMsg($err, $sql, __FILE__, __LINE__);
//                return (FALSE);
//            }
//
//            // Bestimme den Tabellennamen der im Slave SQL Statement benutzt wird
//            $arr = explode(" ", $sql); //
//            if ("insert" == mb_strtolower(mb_substr(ltrim($sql), 0, 6))) {
//
//                if (mysql_affected_rows() > 0) {
//                    // Lade gerade geschriebenen Record
//                    $slaveTableName = mb_strtolower($arr[1]) == "into" ? $arr[2] : $arr[1]; // sql: "insert into <table> ..... der dritte Parameter ist der Tabellenname
//
//                    // Lese die Id des neu angelegten DS
//                    $slaveId = mysql_insert_id();
//
//                    // Bei einigen Tabellen gibt es keine Spalte 'id' - darum die gesuchte Spalte ueber die Definition von auto_increment  bestimmen. I.d.R. 'id'
//                    // Bsp: einfuegen von fe_usern in die T3 Tabelle 'fe_users'
//                    $sql = "show fields from $slaveTableName where Extra like 'auto_increment'";
//                    if (!($tmp = $this->doQuerySingle($sql, $err))) {
//                        $this->buildMySQLErrMsg($err, $sql, __FILE__, __LINE__);
//                        return (FALSE);
//                    }
//                    $colNameId = $tmp["Field"];
//
//                    // Lade den durch addNupdate erzeugten record
//                    $sql = "select *, $colNameId as id from $slaveTableName where $colNameId = $slaveId ";
//                    if (!($slaveDs = $this->doQuerySingle($sql, $err))) {
//                        $this->buildMySQLErrMsg($err, $sql, __FILE__, __LINE__);
//                        return (FALSE);
//                    }
//                }
//
//
//                // Ersetze Variablen in dem SQL do after Statement
//                $sql = $this->substituteAssoc($formularDs["sql_do_after"], $masterDs); // masterDs
//                if ($sql) {
//
//                    if ($this->DebugLevel > 0)
//                        echo("doAddNUpdate/sql_do_after(new):" . $sql . "<BR>");
//
//                    $sql = str_replace("~_", "~", $sql);
//                    $sql = $this->substituteAssoc($sql, $slaveDs);                                                    // slaveDs
//
//                    if ($this->DebugLevel > 0) t3lib_div::debug("doAddNUpdate/sql_do_after(insert):" . $sql);
//
//                    // Führe das Update auf den Slave DS aus.
//                    if ($this->DebugLevel > 1) t3lib_div::debug($sql);
//                    if (!($res = $this->doSQL(MATH_DB_NAME, $sql))) {
//                        $this->buildMySQLErrMsg($err, $sql, __FILE__, __LINE__);
//                        return (FALSE);
//                    }
//                }
//            } else {
//                if ($this->DebugLevel > 0) echo("doAddNUpdate/sql_do_after - in sql kein select gefunden:" . $sql . "<BR>");
//            }
//        }
//    } // while()
//
//    return (TRUE);
//} // doAddNUpdate