xref: /plugin/bez/mdl/Factory.php (revision b05908268e37f14f59ea1bcf6b4807b5d0e822e3)
1de02284cSSzymon Olewniczak<?php
2de02284cSSzymon Olewniczak
3de02284cSSzymon Olewniczaknamespace dokuwiki\plugin\bez\mdl;
4de02284cSSzymon Olewniczak
5a0cd8c78SSzymon Olewniczakuse dokuwiki\plugin\bez\meta\PermissionDeniedException;
6a0cd8c78SSzymon Olewniczak
7a0cd8c78SSzymon Olewniczakdefine('BEZ_TABLE_PERMISSION_UNKNOWN', -1);
8a0cd8c78SSzymon Olewniczakdefine('BEZ_TABLE_PERMISSION_SELECT', 0);
9a0cd8c78SSzymon Olewniczakdefine('BEZ_TABLE_PERMISSION_INSERT', 1);
10a0cd8c78SSzymon Olewniczak
11de02284cSSzymon Olewniczakabstract class Factory {
12de02284cSSzymon Olewniczak    /** @var Model */
13de02284cSSzymon Olewniczak	protected $model;
14de02284cSSzymon Olewniczak
15a0cd8c78SSzymon Olewniczak	public function permission() {
16a0cd8c78SSzymon Olewniczak	    return BEZ_TABLE_PERMISSION_INSERT;
17a0cd8c78SSzymon Olewniczak    }
18e8827d73SSzymon Olewniczak
19de02284cSSzymon Olewniczak	protected function filter_field_map($field) {
20ff14b107SSzymon Olewniczak        $table = $this->get_table_view();
21ff14b107SSzymon Olewniczak        if (!$table) {
22ff14b107SSzymon Olewniczak            $table = $this->get_table_name();
23de02284cSSzymon Olewniczak        }
24de02284cSSzymon Olewniczak
25ff14b107SSzymon Olewniczak	    return "$table.$field";
26ff14b107SSzymon Olewniczak    }
27ff14b107SSzymon Olewniczak
28ff14b107SSzymon Olewniczak    protected function select_query() {
29ff14b107SSzymon Olewniczak	    $table = $this->get_table_view();
30ff14b107SSzymon Olewniczak	    if (!$table) {
31ff14b107SSzymon Olewniczak	        $table = $this->get_table_name();
32ff14b107SSzymon Olewniczak        }
33ff14b107SSzymon Olewniczak        return "SELECT * FROM $table";
34ff14b107SSzymon Olewniczak    }
35ff14b107SSzymon Olewniczak
36ff14b107SSzymon Olewniczak    public function get_table_view() {
37ff14b107SSzymon Olewniczak	    return false;
38ff14b107SSzymon Olewniczak    }
39de02284cSSzymon Olewniczak
40de02284cSSzymon Olewniczak    protected function build_where($filters=array()) {
41de02284cSSzymon Olewniczak		$execute = array();
42de02284cSSzymon Olewniczak		$where_q = array();
43de02284cSSzymon Olewniczak		foreach ($filters as $filter => $value) {
44de02284cSSzymon Olewniczak            $field = $this->filter_field_map($filter);
45de02284cSSzymon Olewniczak
46de02284cSSzymon Olewniczak            //parser
47de02284cSSzymon Olewniczak			$operator = '=';
48de02284cSSzymon Olewniczak            $function = '';
49de02284cSSzymon Olewniczak            $function_args = array();
50de02284cSSzymon Olewniczak			if (is_array($value)) {
51de02284cSSzymon Olewniczak                $operators = array('!=', '<', '>', '<=', '>=', 'LIKE', 'BETWEEN', 'OR');
52de02284cSSzymon Olewniczak                $functions = array('', 'date');
53de02284cSSzymon Olewniczak
54de02284cSSzymon Olewniczak                $operator = $value[0];
55de02284cSSzymon Olewniczak                $function = isset($value[2]) ? $value[2] : '';
56de02284cSSzymon Olewniczak
57de02284cSSzymon Olewniczak                if (is_array($function)) {
58de02284cSSzymon Olewniczak                    $function = $function[0];
59de02284cSSzymon Olewniczak                    $function_args = array_slice($value[2], 1);
60de02284cSSzymon Olewniczak                }
61de02284cSSzymon Olewniczak
62de02284cSSzymon Olewniczak                $value = $value[1];
63de02284cSSzymon Olewniczak
64de02284cSSzymon Olewniczak				if (!in_array($operator, $operators)) {
65de02284cSSzymon Olewniczak                    throw new \Exception('unknown operator: '.$operator);
66de02284cSSzymon Olewniczak                }
67de02284cSSzymon Olewniczak
68de02284cSSzymon Olewniczak                if (!in_array($function, $functions)) {
69de02284cSSzymon Olewniczak                    throw new \Exception('unknown function: '.$function);
70de02284cSSzymon Olewniczak                }
71de02284cSSzymon Olewniczak			}
72de02284cSSzymon Olewniczak
73de02284cSSzymon Olewniczak            //builder
74de02284cSSzymon Olewniczak            if ($operator === 'BETWEEN') {
75de02284cSSzymon Olewniczak                if (count($value) < 2) {
76de02284cSSzymon Olewniczak                    throw new \Exception('wrong BETWEEN argument. provide two values');
77de02284cSSzymon Olewniczak                }
78de02284cSSzymon Olewniczak                if ($function !== '') {
79de02284cSSzymon Olewniczak                    array_unshift($function_args, $field);
80de02284cSSzymon Olewniczak                    $where_q[] = "$function(".implode(',', $function_args).") BETWEEN :${filter}_start AND :${filter}_end";
81de02284cSSzymon Olewniczak                } else {
82de02284cSSzymon Olewniczak                    $where_q[] = "$field BETWEEN :${filter}_start AND :${filter}_end";
83de02284cSSzymon Olewniczak                }
84de02284cSSzymon Olewniczak                $execute[":${filter}_start"] = $value[0];
85de02284cSSzymon Olewniczak                $execute[":${filter}_end"] = $value[1];
86de02284cSSzymon Olewniczak            } elseif ($operator === 'OR') {
87de02284cSSzymon Olewniczak                if (!is_array($value)) {
88de02284cSSzymon Olewniczak                    throw new \Exception('$data should be an array');
89de02284cSSzymon Olewniczak                }
90de02284cSSzymon Olewniczak
91de02284cSSzymon Olewniczak                $where_array = array();
92de02284cSSzymon Olewniczak
93de02284cSSzymon Olewniczak                foreach ($value as $k => $v) {
94de02284cSSzymon Olewniczak                    $exec = ":${filter}_$k";
95de02284cSSzymon Olewniczak                    $where_array[] = "$field = $exec";
96de02284cSSzymon Olewniczak                    $execute[$exec] = $v;
97de02284cSSzymon Olewniczak                }
98de02284cSSzymon Olewniczak                $where_q[] = '('.implode(' OR ', $where_array).')';
99de02284cSSzymon Olewniczak
100de02284cSSzymon Olewniczak
101de02284cSSzymon Olewniczak            } else {
102de02284cSSzymon Olewniczak                if ($function !== '') {
103de02284cSSzymon Olewniczak                    array_unshift($function_args, $field);
104de02284cSSzymon Olewniczak                    $where_q[] = "$function(".implode(',', $function_args).") $operator :$filter";
10553df74e7SSzymon Olewniczak                    $execute[":$filter"] = $value;
10653df74e7SSzymon Olewniczak                } elseif (empty($value)) {
10753df74e7SSzymon Olewniczak                    $where_q[] = "($field IS NULL OR $field = '')";
108de02284cSSzymon Olewniczak                } else {
109de02284cSSzymon Olewniczak                    $where_q[] = "$field $operator :$filter";
110de02284cSSzymon Olewniczak                    $execute[":$filter"] = $value;
111de02284cSSzymon Olewniczak                }
11253df74e7SSzymon Olewniczak
11353df74e7SSzymon Olewniczak            }
114de02284cSSzymon Olewniczak		}
115de02284cSSzymon Olewniczak
116de02284cSSzymon Olewniczak		$where = '';
117de02284cSSzymon Olewniczak		if (count($where_q) > 0) {
118de02284cSSzymon Olewniczak			$where = ' WHERE '.implode(' AND ', $where_q);
119de02284cSSzymon Olewniczak		}
120de02284cSSzymon Olewniczak		return array($where, $execute);
121de02284cSSzymon Olewniczak	}
122de02284cSSzymon Olewniczak
123de02284cSSzymon Olewniczak	public function __construct(Model $model) {
124de02284cSSzymon Olewniczak		$this->model = $model;
125de02284cSSzymon Olewniczak	}
126de02284cSSzymon Olewniczak
127038c5d4aSSzymon Olewniczak    public function get_all($filters=array(), $orderby='', $defaults=array(), $limit=false) {
128de02284cSSzymon Olewniczak
129de02284cSSzymon Olewniczak        list($where_q, $execute) = $this->build_where($filters);
130de02284cSSzymon Olewniczak
131de02284cSSzymon Olewniczak		$q = $this->select_query() . $where_q;
132de02284cSSzymon Olewniczak
133fe5d6d1eSSzymon Olewniczak		if ($orderby != '') {
134038c5d4aSSzymon Olewniczak		    if (is_array($orderby)) $orderby = implode(', ', $orderby);
135fe5d6d1eSSzymon Olewniczak		    $q .= " ORDER BY $orderby";
136fe5d6d1eSSzymon Olewniczak        }
137fe5d6d1eSSzymon Olewniczak
138e8827d73SSzymon Olewniczak        if (is_int($limit)) {
139e8827d73SSzymon Olewniczak		    $q .= " LIMIT $limit";
140e8827d73SSzymon Olewniczak        }
141e8827d73SSzymon Olewniczak
142de02284cSSzymon Olewniczak		$sth = $this->model->db->prepare($q);
143de02284cSSzymon Olewniczak
144de02284cSSzymon Olewniczak        $sth->setFetchMode(\PDO::FETCH_CLASS, $this->get_object_class_name(),
1458a638198SSzymon Olewniczak                           array($this->model, $defaults));
146de02284cSSzymon Olewniczak
147de02284cSSzymon Olewniczak		$sth->execute($execute);
148de02284cSSzymon Olewniczak
149de02284cSSzymon Olewniczak		return $sth;
150de02284cSSzymon Olewniczak    }
151de02284cSSzymon Olewniczak
152de02284cSSzymon Olewniczak    public function count($filters=array()) {
153ff14b107SSzymon Olewniczak        $table = $this->get_table_view();
154ff14b107SSzymon Olewniczak        if (!$table) {
155ff14b107SSzymon Olewniczak            $table = $this->get_table_name();
156ff14b107SSzymon Olewniczak        }
157de02284cSSzymon Olewniczak
158de02284cSSzymon Olewniczak        list($where_q, $execute) = $this->build_where($filters);
159de02284cSSzymon Olewniczak
160ff14b107SSzymon Olewniczak        $q = "SELECT COUNT(*) FROM $table " . $where_q;
161de02284cSSzymon Olewniczak        $sth = $this->model->db->prepare($q);
162de02284cSSzymon Olewniczak        $sth->execute($execute);
163de02284cSSzymon Olewniczak
164de02284cSSzymon Olewniczak        $count = $sth->fetchColumn();
165de02284cSSzymon Olewniczak        return $count;
166de02284cSSzymon Olewniczak    }
167de02284cSSzymon Olewniczak
168*b0590826SSzymon Olewniczak    public function exists($id) {
169*b0590826SSzymon Olewniczak        $table = $this->get_table_name();
170*b0590826SSzymon Olewniczak        $q = "SELECT id FROM $table WHERE id = ?";
171*b0590826SSzymon Olewniczak
172*b0590826SSzymon Olewniczak        $sth = $this->model->db->prepare($q);
173*b0590826SSzymon Olewniczak        $sth->execute(array($id));
174*b0590826SSzymon Olewniczak
175*b0590826SSzymon Olewniczak        if ($sth->fetch()) {
176*b0590826SSzymon Olewniczak            return true;
177*b0590826SSzymon Olewniczak        }
178*b0590826SSzymon Olewniczak
179*b0590826SSzymon Olewniczak        return false;
180*b0590826SSzymon Olewniczak    }
181*b0590826SSzymon Olewniczak
1828a638198SSzymon Olewniczak    public function get_one($id, $defaults=array()) {
183ff14b107SSzymon Olewniczak        $table = $this->get_table_view();
184ff14b107SSzymon Olewniczak        if (!$table) {
185ff14b107SSzymon Olewniczak            $table = $this->get_table_name();
186ff14b107SSzymon Olewniczak        }
187de02284cSSzymon Olewniczak
188ff14b107SSzymon Olewniczak		$q = $this->select_query()." WHERE $table.id = ?";
189de02284cSSzymon Olewniczak
190de02284cSSzymon Olewniczak		$sth = $this->model->db->prepare($q);
191de02284cSSzymon Olewniczak		$sth->execute(array($id));
192de02284cSSzymon Olewniczak
193de02284cSSzymon Olewniczak		$obj = $sth->fetchObject($this->get_object_class_name(),
1948a638198SSzymon Olewniczak					array($this->model, $defaults));
195de02284cSSzymon Olewniczak
196de02284cSSzymon Olewniczak        if ($obj === false) {
197de02284cSSzymon Olewniczak            throw new \Exception('there is no '.$this->get_table_name().' with id: '.$id);
198de02284cSSzymon Olewniczak        }
199de02284cSSzymon Olewniczak
200de02284cSSzymon Olewniczak		return $obj;
201de02284cSSzymon Olewniczak	}
202de02284cSSzymon Olewniczak
203de02284cSSzymon Olewniczak	public function get_table_name() {
204de02284cSSzymon Olewniczak        $class = (new \ReflectionClass($this))->getShortName();
205de02284cSSzymon Olewniczak        return lcfirst(str_replace('Factory', '', $class));
206de02284cSSzymon Olewniczak	}
207de02284cSSzymon Olewniczak
208de02284cSSzymon Olewniczak    public function get_object_class_name() {
209de02284cSSzymon Olewniczak        $class = (new \ReflectionClass($this))->getName();
210de02284cSSzymon Olewniczak        return str_replace('Factory', '', $class);
211de02284cSSzymon Olewniczak    }
212de02284cSSzymon Olewniczak
213de02284cSSzymon Olewniczak    public function create_object($defaults=array()) {
214de02284cSSzymon Olewniczak        $object_name = $this->get_object_class_name();
215de02284cSSzymon Olewniczak
216de02284cSSzymon Olewniczak		$obj = new $object_name($this->model, $defaults);
217de02284cSSzymon Olewniczak		return $obj;
218de02284cSSzymon Olewniczak	}
219de02284cSSzymon Olewniczak
2207fbf4c39SSzymon Olewniczak	protected function beginTransaction() {
221de02284cSSzymon Olewniczak        $this->model->sqlite->query('BEGIN TRANSACTION');
222de02284cSSzymon Olewniczak    }
223de02284cSSzymon Olewniczak
2247fbf4c39SSzymon Olewniczak    protected function commitTransaction() {
225de02284cSSzymon Olewniczak        $this->model->sqlite->query('COMMIT TRANSACTION');
226de02284cSSzymon Olewniczak    }
227de02284cSSzymon Olewniczak
2287fbf4c39SSzymon Olewniczak    protected function rollbackTransaction() {
229de02284cSSzymon Olewniczak        $this->model->sqlite->query('ROLLBACK');
230de02284cSSzymon Olewniczak    }
231de02284cSSzymon Olewniczak
23253df74e7SSzymon Olewniczak	protected function insert(Entity $obj) {
23353df74e7SSzymon Olewniczak        if ($obj->id != NULL) {
23453df74e7SSzymon Olewniczak            throw new \Exception('row already saved');
23553df74e7SSzymon Olewniczak        }
23653df74e7SSzymon Olewniczak
237de02284cSSzymon Olewniczak        $set = array();
238de02284cSSzymon Olewniczak        $execute = array();
239de02284cSSzymon Olewniczak        $columns = array();
240de02284cSSzymon Olewniczak        foreach ($obj->get_columns() as $column) {
241de02284cSSzymon Olewniczak            if ($obj->$column === null) continue;
242de02284cSSzymon Olewniczak            $set[] = ":$column";
243de02284cSSzymon Olewniczak            $columns[] = $column;
244de02284cSSzymon Olewniczak            $value = $obj->$column;
245de02284cSSzymon Olewniczak            if ($value === '') {
246de02284cSSzymon Olewniczak                $execute[':'.$column] = null;
247de02284cSSzymon Olewniczak            } else {
248de02284cSSzymon Olewniczak                $execute[':'.$column] = $value;
249de02284cSSzymon Olewniczak            }
250de02284cSSzymon Olewniczak        }
251de02284cSSzymon Olewniczak
25253df74e7SSzymon Olewniczak        $query = 'INSERT INTO '.$this->get_table_name().'
253de02284cSSzymon Olewniczak							('.implode(',', $columns).')
254de02284cSSzymon Olewniczak							VALUES ('.implode(',', $set).')';
255de02284cSSzymon Olewniczak
256de02284cSSzymon Olewniczak        $sth = $this->model->db->prepare($query);
25753df74e7SSzymon Olewniczak        $sth->execute($execute);
258de02284cSSzymon Olewniczak
259de02284cSSzymon Olewniczak        $reflectionClass = new \ReflectionClass($obj);
260de02284cSSzymon Olewniczak        $reflectionProperty = $reflectionClass->getProperty('id');
261de02284cSSzymon Olewniczak        $reflectionProperty->setAccessible(true);
262de02284cSSzymon Olewniczak        $reflectionProperty->setValue($obj, $this->model->db->lastInsertId());
26353df74e7SSzymon Olewniczak
264de02284cSSzymon Olewniczak    }
26553df74e7SSzymon Olewniczak
26653df74e7SSzymon Olewniczak    protected function update(Entity $obj) {
26753df74e7SSzymon Olewniczak        if ($obj->id == NULL) {
26853df74e7SSzymon Olewniczak            throw new \Exception('row not inserted');
26953df74e7SSzymon Olewniczak        }
27053df74e7SSzymon Olewniczak
27153df74e7SSzymon Olewniczak        $set = array();
27253df74e7SSzymon Olewniczak        $execute = array(':id' => $obj->id);
27353df74e7SSzymon Olewniczak        foreach ($obj->get_columns() as $column) {
27453df74e7SSzymon Olewniczak            if ($column == 'id') continue;
27553df74e7SSzymon Olewniczak            $set[] = "$column=:$column";
27653df74e7SSzymon Olewniczak            $value = $obj->$column;
27753df74e7SSzymon Olewniczak            if ($value === '') {
27853df74e7SSzymon Olewniczak                $execute[':'.$column] = null;
27953df74e7SSzymon Olewniczak            } else {
28053df74e7SSzymon Olewniczak                $execute[':'.$column] = $value;
28153df74e7SSzymon Olewniczak            }
28253df74e7SSzymon Olewniczak        }
28353df74e7SSzymon Olewniczak
28453df74e7SSzymon Olewniczak        $query = 'UPDATE ' . $this->get_table_name() .
28553df74e7SSzymon Olewniczak                    ' SET ' . implode(',', $set) .
28653df74e7SSzymon Olewniczak                    ' WHERE id=:id';
28753df74e7SSzymon Olewniczak
28853df74e7SSzymon Olewniczak        $sth = $this->model->db->prepare($query);
28953df74e7SSzymon Olewniczak        $sth->execute($execute);
290de02284cSSzymon Olewniczak    }
291de02284cSSzymon Olewniczak
2928a638198SSzymon Olewniczak    public function initial_save(Entity $obj, $data) {
29353df74e7SSzymon Olewniczak	    $obj->set_data($data);
29453df74e7SSzymon Olewniczak	    $this->insert($obj);
2958a638198SSzymon Olewniczak    }
2968a638198SSzymon Olewniczak
2978a638198SSzymon Olewniczak    public function update_save(Entity $obj, $data) {
29853df74e7SSzymon Olewniczak	    $obj->set_data($data);
29953df74e7SSzymon Olewniczak	    $this->update($obj);
30053df74e7SSzymon Olewniczak    }
30153df74e7SSzymon Olewniczak
30253df74e7SSzymon Olewniczak    public function save(Entity $obj) {
3038a638198SSzymon Olewniczak	    if ($obj->id == NULL) {
30453df74e7SSzymon Olewniczak	        $this->insert($obj);
30553df74e7SSzymon Olewniczak        } else {
30653df74e7SSzymon Olewniczak	        $this->update($obj);
3078a638198SSzymon Olewniczak        }
3088a638198SSzymon Olewniczak    }
3098a638198SSzymon Olewniczak
310de02284cSSzymon Olewniczak	protected function delete_from_db($id) {
311de02284cSSzymon Olewniczak		$q = 'DELETE FROM '.$this->get_table_name().' WHERE id = ?';
312de02284cSSzymon Olewniczak		$sth = $this->model->db->prepare($q);
313de02284cSSzymon Olewniczak		$sth->execute(array($id));
314de02284cSSzymon Olewniczak	}
315de02284cSSzymon Olewniczak
316de02284cSSzymon Olewniczak	public function delete(Entity $obj) {
317a0cd8c78SSzymon Olewniczak        if ($obj->acl_of('id') < BEZ_PERMISSION_DELETE) {
318a0cd8c78SSzymon Olewniczak            throw new PermissionDeniedException('cannot delete');
319a0cd8c78SSzymon Olewniczak        }
320de02284cSSzymon Olewniczak		$this->delete_from_db($obj->id);
321de02284cSSzymon Olewniczak	}
322de02284cSSzymon Olewniczak}
323