User.php
272 lines
| 1 | <?php |
| 2 | |
| 3 | /** |
| 4 | * ====================================================================== |
| 5 | * LICENSE: This file is subject to the terms and conditions defined in * |
| 6 | * file 'license.txt', which is part of this source code package. * |
| 7 | * ====================================================================== |
| 8 | */ |
| 9 | |
| 10 | /** |
| 11 | * User view manager |
| 12 | * |
| 13 | * @package AAM |
| 14 | * @author Vasyl Martyniuk <vasyl@vasyltech.com> |
| 15 | */ |
| 16 | class AAM_Backend_Feature_Subject_User { |
| 17 | |
| 18 | /** |
| 19 | * Retrieve list of users |
| 20 | * |
| 21 | * Based on filters, get list of users |
| 22 | * |
| 23 | * @return string JSON encoded list of users |
| 24 | * |
| 25 | * @access public |
| 26 | */ |
| 27 | public function getTable() { |
| 28 | $response = array( |
| 29 | 'recordsTotal' => 0, |
| 30 | 'recordsFiltered' => 0, |
| 31 | 'draw' => AAM_Core_Request::request('draw'), |
| 32 | 'data' => array(), |
| 33 | ); |
| 34 | |
| 35 | if (current_user_can('list_users')) { |
| 36 | //get total number of users |
| 37 | $total = count_users(); |
| 38 | $result = $this->query(); |
| 39 | |
| 40 | $response['recordsTotal'] = $total['total_users']; |
| 41 | $response['recordsFiltered'] = $result->get_total(); |
| 42 | |
| 43 | foreach ($result->get_results() as $row) { |
| 44 | $response['data'][] = $this->prepareRow( |
| 45 | new AAM_Core_Subject_User($row->ID) |
| 46 | ); |
| 47 | } |
| 48 | } |
| 49 | |
| 50 | return json_encode($response); |
| 51 | } |
| 52 | |
| 53 | /** |
| 54 | * Save user expiration |
| 55 | * |
| 56 | * @return string |
| 57 | * |
| 58 | * @access public |
| 59 | */ |
| 60 | public function saveExpiration() { |
| 61 | $response = array( |
| 62 | 'status' => 'failure', |
| 63 | 'reason' => __('Operation is not permitted', AAM_KEY) |
| 64 | ); |
| 65 | |
| 66 | $userId = filter_input(INPUT_POST, 'user'); |
| 67 | $expires = filter_input(INPUT_POST, 'expires'); |
| 68 | $action = filter_input(INPUT_POST, 'after'); |
| 69 | $role = filter_input(INPUT_POST, 'role'); |
| 70 | |
| 71 | if (current_user_can('edit_users')) { |
| 72 | if ($userId != get_current_user_id()) { |
| 73 | if ($this->isAllowed(new AAM_Core_Subject_User($userId))) { |
| 74 | $this->updateUserExpiration($userId, $expires, $action, $role); |
| 75 | $response['status'] = 'success'; |
| 76 | } |
| 77 | } else { |
| 78 | $response['reason'] = __('You cannot set expiration to yourself', AAM_KEY); |
| 79 | } |
| 80 | } |
| 81 | |
| 82 | return json_encode($response); |
| 83 | } |
| 84 | |
| 85 | /** |
| 86 | * Query database for list of users |
| 87 | * |
| 88 | * Based on filters and settings get the list of users from database |
| 89 | * |
| 90 | * @return \WP_User_Query |
| 91 | * |
| 92 | * @access public |
| 93 | */ |
| 94 | public function query() { |
| 95 | $search = trim(AAM_Core_Request::request('search.value')); |
| 96 | $role = trim(AAM_Core_Request::request('role')); |
| 97 | |
| 98 | $args = array( |
| 99 | 'blog_id' => get_current_blog_id(), |
| 100 | 'fields' => 'all', |
| 101 | 'number' => AAM_Core_Request::request('length'), |
| 102 | 'offset' => AAM_Core_Request::request('start'), |
| 103 | 'search' => ($search ? $search . '*' : ''), |
| 104 | 'search_columns' => array( |
| 105 | 'user_login', 'user_email', 'display_name' |
| 106 | ), |
| 107 | 'orderby' => 'user_nicename', |
| 108 | 'order' => 'ASC' |
| 109 | ); |
| 110 | |
| 111 | if (!empty($role)) { |
| 112 | $args['role__in'] = $role; |
| 113 | } |
| 114 | |
| 115 | return new WP_User_Query($args); |
| 116 | } |
| 117 | |
| 118 | /** |
| 119 | * Block user |
| 120 | * |
| 121 | * @return string |
| 122 | * |
| 123 | * @access public |
| 124 | */ |
| 125 | public function block() { |
| 126 | $result = false; |
| 127 | |
| 128 | if (current_user_can('aam_toggle_users') && current_user_can('edit_users')) { |
| 129 | $subject = AAM_Backend_Subject::getInstance(); |
| 130 | |
| 131 | if ($this->isAllowed($subject->get())) { |
| 132 | //user is not allowed to lock himself |
| 133 | if ($subject->getId() != get_current_user_id()) { |
| 134 | $result = $subject->block(); |
| 135 | } |
| 136 | } |
| 137 | } |
| 138 | |
| 139 | return json_encode(array('status' => ($result ? 'success' : 'failure'))); |
| 140 | } |
| 141 | |
| 142 | /** |
| 143 | * Prepare row |
| 144 | * |
| 145 | * @param AAM_Core_Subject_User $user |
| 146 | * |
| 147 | * @return array |
| 148 | * |
| 149 | * @access protected |
| 150 | */ |
| 151 | protected function prepareRow(AAM_Core_Subject_User $user) { |
| 152 | return array( |
| 153 | $user->ID, |
| 154 | implode(', ', $this->getUserRoles($user->roles)), |
| 155 | ($user->display_name ? $user->display_name : $user->user_nicename), |
| 156 | implode(',', $this->prepareRowActions($user)), |
| 157 | AAM_Core_API::maxLevel($user->allcaps), |
| 158 | $this->getUserExpiration($user) |
| 159 | ); |
| 160 | } |
| 161 | |
| 162 | /** |
| 163 | * Get list of user roles |
| 164 | * |
| 165 | * @param array $roles |
| 166 | * |
| 167 | * @return array |
| 168 | * |
| 169 | * @access protected |
| 170 | */ |
| 171 | protected function getUserRoles($roles) { |
| 172 | $response = array(); |
| 173 | |
| 174 | $names = AAM_Core_API::getRoles()->get_names(); |
| 175 | |
| 176 | if (is_array($roles)) { |
| 177 | foreach($roles as $role) { |
| 178 | if (array_key_exists($role, $names)) { |
| 179 | $response[] = translate_user_role($names[$role]); |
| 180 | } |
| 181 | } |
| 182 | } |
| 183 | |
| 184 | return $response; |
| 185 | } |
| 186 | |
| 187 | /** |
| 188 | * Prepare user row actions |
| 189 | * |
| 190 | * @param WP_User $user |
| 191 | * |
| 192 | * @return array |
| 193 | * |
| 194 | * @access protected |
| 195 | */ |
| 196 | protected function prepareRowActions(AAM_Core_Subject_User $user) { |
| 197 | if ($this->isAllowed($user) || ($user->ID == get_current_user_id())) { |
| 198 | $actions = array('manage'); |
| 199 | |
| 200 | if (AAM_Core_Config::get('core.settings.secureLogin', true) |
| 201 | && current_user_can('aam_toggle_users')) { |
| 202 | $actions[] = ($user->user_status ? 'unlock' : 'lock'); |
| 203 | } |
| 204 | |
| 205 | if (current_user_can('edit_users')) { |
| 206 | $actions[] = 'edit'; |
| 207 | $actions[] = 'ttl'; |
| 208 | } |
| 209 | |
| 210 | if (current_user_can('aam_switch_users')) { |
| 211 | $actions[] = 'switch'; |
| 212 | } |
| 213 | } else { |
| 214 | $actions = array(); |
| 215 | } |
| 216 | |
| 217 | return $actions; |
| 218 | } |
| 219 | |
| 220 | /** |
| 221 | * Update user expiration |
| 222 | * |
| 223 | * @param int $user |
| 224 | * @param string $expires |
| 225 | * @param string $action |
| 226 | * @param string $role |
| 227 | * |
| 228 | * @return bool |
| 229 | * |
| 230 | * @access protected |
| 231 | */ |
| 232 | protected function updateUserExpiration($user, $expires, $action, $role = '') { |
| 233 | if (trim($expires)) { |
| 234 | update_user_meta( |
| 235 | $user, |
| 236 | 'aam_user_expiration', |
| 237 | date('Y-m-d H:i:s', strtotime($expires)) . "|" . ($action ? $action : 'delete') . '|' . $role |
| 238 | ); |
| 239 | } else { |
| 240 | delete_user_meta($user, 'aam_user_expiration'); |
| 241 | } |
| 242 | } |
| 243 | |
| 244 | /** |
| 245 | * Get user expiration |
| 246 | * |
| 247 | * @param WP_User $user |
| 248 | * |
| 249 | * @return string |
| 250 | * |
| 251 | * @access protected |
| 252 | */ |
| 253 | protected function getUserExpiration(AAM_Core_Subject_User $user) { |
| 254 | return get_user_meta($user->ID, 'aam_user_expiration', true); |
| 255 | } |
| 256 | |
| 257 | /** |
| 258 | * Check max user allowance |
| 259 | * |
| 260 | * @param AAM_Core_Subject_User $user |
| 261 | * |
| 262 | * @return boolean |
| 263 | * |
| 264 | * @access protected |
| 265 | */ |
| 266 | protected function isAllowed(AAM_Core_Subject_User $user) { |
| 267 | $max = AAM_Core_API::maxLevel(AAM::getUser()->allcaps); |
| 268 | |
| 269 | return $max >= AAM_Core_API::maxLevel($user->allcaps); |
| 270 | } |
| 271 | |
| 272 | } |