xref: /plugin/bez/mdl/Entity.php (revision 17e5ba2e368ec05e910550acf2c6f8a4e66b7bb2)
1de02284cSSzymon Olewniczak<?php
2de02284cSSzymon Olewniczak
3de02284cSSzymon Olewniczaknamespace dokuwiki\plugin\bez\mdl;
4de02284cSSzymon Olewniczak/*
5de02284cSSzymon Olewniczak * All fields are stored in object as strings.
6de02284cSSzymon Olewniczak * NULLs are converted to empty string.
7de02284cSSzymon Olewniczak * If any attribute in object === NULL -> it means that it was not initialized
8de02284cSSzymon Olewniczak * But we always inserts NULLs instead of empty strings.
9de02284cSSzymon Olewniczak * https://stackoverflow.com/questions/1267999/mysql-better-to-insert-null-or-empty-string
10de02284cSSzymon Olewniczak **/
11de02284cSSzymon Olewniczak
12de02284cSSzymon Olewniczakuse dokuwiki\plugin\bez\meta\PermissionDeniedException;
138a638198SSzymon Olewniczakuse dokuwiki\plugin\bez\meta\ValidationException;
14*17e5ba2eSSzymon Olewniczakuse Mailer;
15de02284cSSzymon Olewniczak
16a0cd8c78SSzymon Olewniczakabstract class Entity {
17de02284cSSzymon Olewniczak
18de02284cSSzymon Olewniczak    /** @var  Model */
19de02284cSSzymon Olewniczak    protected $model;
20de02284cSSzymon Olewniczak
21de02284cSSzymon Olewniczak    /** @var Validator */
22de02284cSSzymon Olewniczak    protected $validator;
23de02284cSSzymon Olewniczak
24a0cd8c78SSzymon Olewniczak    /** @var Acl */
25a0cd8c78SSzymon Olewniczak    protected $acl;
26a0cd8c78SSzymon Olewniczak
27de02284cSSzymon Olewniczak	abstract public static function get_columns();
28de02284cSSzymon Olewniczak
297fbf4c39SSzymon Olewniczak	public static function get_select_columns() {
307fbf4c39SSzymon Olewniczak        $class = get_called_class();
317fbf4c39SSzymon Olewniczak	    return $class::get_columns();
327fbf4c39SSzymon Olewniczak    }
337fbf4c39SSzymon Olewniczak
34b331b892SSzymon Olewniczak    public static function get_acl_columns() {
35b331b892SSzymon Olewniczak        $class = get_called_class();
36b331b892SSzymon Olewniczak        return $class::get_select_columns();
37b331b892SSzymon Olewniczak    }
38b331b892SSzymon Olewniczak
39de02284cSSzymon Olewniczak	public function get_assoc($filter=NULL) {
40de02284cSSzymon Olewniczak		$assoc = array();
41de02284cSSzymon Olewniczak
427fbf4c39SSzymon Olewniczak        $columns = $this->get_select_columns();
43de02284cSSzymon Olewniczak        if ($filter !== NULL) {
44de02284cSSzymon Olewniczak            $columns = array_intersect($columns, $filter);
45de02284cSSzymon Olewniczak        }
46de02284cSSzymon Olewniczak
47de02284cSSzymon Olewniczak		foreach ($columns as $col) {
48de02284cSSzymon Olewniczak			$assoc[$col] = $this->$col;
49de02284cSSzymon Olewniczak		}
50de02284cSSzymon Olewniczak		return $assoc;
51de02284cSSzymon Olewniczak	}
52de02284cSSzymon Olewniczak
53de02284cSSzymon Olewniczak    public function get_table_name() {
54de02284cSSzymon Olewniczak        $class = (new \ReflectionClass($this))->getShortName();
55de02284cSSzymon Olewniczak		return lcfirst($class);
56de02284cSSzymon Olewniczak	}
57de02284cSSzymon Olewniczak
58de02284cSSzymon Olewniczak	public function __get($property) {
598e1f1543SSzymon Olewniczak        if (!property_exists($this, $property) || !in_array($property, $this->get_select_columns())) {
60de02284cSSzymon Olewniczak            throw new \Exception('there is no column: "'.$property. '"" in table: "' . $this->get_table_name() . '"');
61de02284cSSzymon Olewniczak        }
62de02284cSSzymon Olewniczak
6314a1f0a4SSzymon Olewniczak        if ($this->acl_of($property) < BEZ_PERMISSION_VIEW) {
6414a1f0a4SSzymon Olewniczak            throw new PermissionDeniedException();
6514a1f0a4SSzymon Olewniczak        }
66de02284cSSzymon Olewniczak
67de02284cSSzymon Olewniczak        return $this->$property;
68de02284cSSzymon Olewniczak
69de02284cSSzymon Olewniczak	}
70de02284cSSzymon Olewniczak
71de02284cSSzymon Olewniczak    protected function set_property($property, $value) {
72a0cd8c78SSzymon Olewniczak        if ($this->acl_of($property) < BEZ_PERMISSION_CHANGE) {
73a0cd8c78SSzymon Olewniczak            throw new PermissionDeniedException("cannot change field $property");
74de02284cSSzymon Olewniczak        }
75de02284cSSzymon Olewniczak        $this->$property = $value;
76de02284cSSzymon Olewniczak    }
77de02284cSSzymon Olewniczak
78de02284cSSzymon Olewniczak    protected function set_property_array($array) {
79de02284cSSzymon Olewniczak        foreach ($array as $k => $v) {
80de02284cSSzymon Olewniczak            $this->set_property($k, $v);
81de02284cSSzymon Olewniczak        }
82de02284cSSzymon Olewniczak    }
83de02284cSSzymon Olewniczak
84de02284cSSzymon Olewniczak    public function set_data($post) {
85de02284cSSzymon Olewniczak        $val_data = $this->validator->validate($post);
86de02284cSSzymon Olewniczak		if ($val_data === false) {
87de02284cSSzymon Olewniczak			throw new ValidationException($this->get_table_name(), $this->validator->get_errors());
88de02284cSSzymon Olewniczak		}
89de02284cSSzymon Olewniczak
90de02284cSSzymon Olewniczak		$this->set_property_array($val_data);
91de02284cSSzymon Olewniczak    }
92501f256bSSzymon Olewniczak
93501f256bSSzymon Olewniczak
94501f256bSSzymon Olewniczak    public function purge() {
95501f256bSSzymon Olewniczak	    if (property_exists($this, 'content') && property_exists($this, 'content_html')) {
96501f256bSSzymon Olewniczak            $rule = $this->validator->get_rule('content');
97501f256bSSzymon Olewniczak
98501f256bSSzymon Olewniczak            $html = p_render('xhtml',p_get_instructions($this->content), $ignore);
99501f256bSSzymon Olewniczak
100501f256bSSzymon Olewniczak            //probably content contains only white spaces
101501f256bSSzymon Olewniczak            if (empty($html) && $rule[1] == 'NOT NULL') {
102501f256bSSzymon Olewniczak                $html = '<p></p>';
103501f256bSSzymon Olewniczak            }
104501f256bSSzymon Olewniczak            $this->content_html = $html;
105501f256bSSzymon Olewniczak        }
106501f256bSSzymon Olewniczak
107501f256bSSzymon Olewniczak    }
108de02284cSSzymon Olewniczak
1097fbf4c39SSzymon Olewniczak    public function changable_fields($filter=NULL) {
110a0cd8c78SSzymon Olewniczak       $fields = $this->acl->get_list();
1117fbf4c39SSzymon Olewniczak
1127fbf4c39SSzymon Olewniczak       if ($filter !== NULL) {
1137fbf4c39SSzymon Olewniczak           $fields = array_filter($fields, function ($k) use ($filter) {
1147fbf4c39SSzymon Olewniczak                return in_array($k, $filter);
1157fbf4c39SSzymon Olewniczak           }, ARRAY_FILTER_USE_KEY);
1167fbf4c39SSzymon Olewniczak       }
1177fbf4c39SSzymon Olewniczak
1187fbf4c39SSzymon Olewniczak       return array_keys(array_filter($fields, function ($var) {
1197fbf4c39SSzymon Olewniczak           return $var >= BEZ_PERMISSION_CHANGE;
1207fbf4c39SSzymon Olewniczak       }));
1217fbf4c39SSzymon Olewniczak    }
122de02284cSSzymon Olewniczak
12353df74e7SSzymon Olewniczak    public function can_be_null($field) {
12453df74e7SSzymon Olewniczak	    $rule = $this->validator->get_rule($field);
12553df74e7SSzymon Olewniczak	    $null = $rule[1];
12653df74e7SSzymon Olewniczak	    if (strtolower($null) == 'null') {
12753df74e7SSzymon Olewniczak	        return true;
12853df74e7SSzymon Olewniczak        }
12953df74e7SSzymon Olewniczak
13053df74e7SSzymon Olewniczak        return false;
13153df74e7SSzymon Olewniczak    }
132de02284cSSzymon Olewniczak
133de02284cSSzymon Olewniczak    public function __construct($model) {
134de02284cSSzymon Olewniczak        $this->model = $model;
135de02284cSSzymon Olewniczak        $this->validator = new Validator($this->model);
136a0cd8c78SSzymon Olewniczak
137b331b892SSzymon Olewniczak        $this->acl = new Acl($this->model->get_level(), $this->get_acl_columns());
138de02284cSSzymon Olewniczak    }
139a0cd8c78SSzymon Olewniczak
140a0cd8c78SSzymon Olewniczak    public function acl_of($field) {
141a0cd8c78SSzymon Olewniczak        return $this->acl->acl_of($field);
142a0cd8c78SSzymon Olewniczak    }
143a0cd8c78SSzymon Olewniczak
1445b88664dSSzymon Olewniczak    protected function html_link_url() {
1455b88664dSSzymon Olewniczak	    return '#';
1465b88664dSSzymon Olewniczak    }
1475b88664dSSzymon Olewniczak
1485b88664dSSzymon Olewniczak    protected function html_link_content() {
1495b88664dSSzymon Olewniczak	    echo $this->id;
1505b88664dSSzymon Olewniczak    }
1515b88664dSSzymon Olewniczak
1525b88664dSSzymon Olewniczak    public function html_link($pre='', $post='', $print=true) {
1535b88664dSSzymon Olewniczak        $ret = '<a href="'.$this->html_link_url().'">';
1545b88664dSSzymon Olewniczak        $ret .= $pre . $this->html_link_content() . $post;
1555b88664dSSzymon Olewniczak        $ret .= '</a>';
1565b88664dSSzymon Olewniczak
1575b88664dSSzymon Olewniczak        if ($print) {
1585b88664dSSzymon Olewniczak            echo $ret;
1595b88664dSSzymon Olewniczak        }
1605b88664dSSzymon Olewniczak        return $ret;
1615b88664dSSzymon Olewniczak	}
1625b88664dSSzymon Olewniczak
16367fdb426SSzymon Olewniczak	protected function getMailSubject() {
16467fdb426SSzymon Olewniczak	    global $conf;
16567fdb426SSzymon Olewniczak        return $conf['title'];
16667fdb426SSzymon Olewniczak    }
16767fdb426SSzymon Olewniczak
16867fdb426SSzymon Olewniczak    //http://data.agaric.com/capture-all-sent-mail-locally-postfix
16967fdb426SSzymon Olewniczak    //https://askubuntu.com/questions/192572/how-do-i-read-local-email-in-thunderbird
17067fdb426SSzymon Olewniczak	public function mail_notify($content, $users=false, $attachedImages=array()) {
17167fdb426SSzymon Olewniczak        global $conf;
17267fdb426SSzymon Olewniczak
173*17e5ba2eSSzymon Olewniczak        $mailer = new Mailer();
174*17e5ba2eSSzymon Olewniczak        $mailer->subject($this->getMailSubject());
17567fdb426SSzymon Olewniczak
17667fdb426SSzymon Olewniczak        if ($users == FALSE) {
17767fdb426SSzymon Olewniczak            $users = $this->get_participants('subscribent');
17867fdb426SSzymon Olewniczak            //don't notify myself
17967fdb426SSzymon Olewniczak            unset($users[$this->model->user_nick]);
18067fdb426SSzymon Olewniczak        }
18167fdb426SSzymon Olewniczak
182bc0bd078SSzymon Olewniczak        $muted_users = $this->model->factory('subscription')->getMutedUsers();
18367fdb426SSzymon Olewniczak        foreach ($users as $user) {
18467fdb426SSzymon Olewniczak            if (is_array($user)) {
18567fdb426SSzymon Olewniczak                $user = $user['user_id'];
18667fdb426SSzymon Olewniczak            }
187bc0bd078SSzymon Olewniczak            //omit muted users
188bc0bd078SSzymon Olewniczak            if (in_array($user, $muted_users)) continue;
189bc0bd078SSzymon Olewniczak
19067fdb426SSzymon Olewniczak            $email = $this->model->userFactory->get_user_email($user);
19132fae04eSSzymon Olewniczak            //do we have user email address
19232fae04eSSzymon Olewniczak            if (!$email) continue;
19332fae04eSSzymon Olewniczak
19467fdb426SSzymon Olewniczak            $name = $this->model->userFactory->get_user_full_name($user);
19532fae04eSSzymon Olewniczak
196*17e5ba2eSSzymon Olewniczak            $mailer->to("$name <$email>");
19767fdb426SSzymon Olewniczak
198*17e5ba2eSSzymon Olewniczak//            $token = $this->model->factory('subscription')->getUserToken($user);
199*17e5ba2eSSzymon Olewniczak//            $resign_link = $this->model->action->url('unsubscribe', array('GET' => array( 't' => $token)));
200*17e5ba2eSSzymon Olewniczak//            $html = str_replace('%%resign_link%%', $resign_link, $content);
201*17e5ba2eSSzymon Olewniczak            $mailer->setBody('', null, null, $content);
202bc0bd078SSzymon Olewniczak
2031a0fddfeSSzymon Olewniczak            try {
20467fdb426SSzymon Olewniczak                $mailer->send();
205*17e5ba2eSSzymon Olewniczak            } catch (\Exception $e) {
2061a0fddfeSSzymon Olewniczak                $msg = $this->get_table_name() . '#' . $this->id . ': ' . $e->getMessage();
2071a0fddfeSSzymon Olewniczak                throw new \Exception($msg);
2081a0fddfeSSzymon Olewniczak            }
20967fdb426SSzymon Olewniczak        }
21067fdb426SSzymon Olewniczak    }
21167fdb426SSzymon Olewniczak
212de02284cSSzymon Olewniczak}
213