mirror/processwire
1
0
Fork 0
mirror of https://github.com/processwire/processwire.git synced 2025-08-16 03:34:33 +02:00
Code Issues Releases Wiki Activity

Add Lister bookmarks support to ProcessUser

Browse Source
This commit is contained in:
Ryan Cramer
2020-11-27 13:26:56 -05:00
parent 1f40c96dbf
commit 9d01111f82
4 changed files with 85 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
wire/core/WireInputData.php
View File

@@ -31,7 +31,7 @@
* @method string pagePathName($varName) Sanitize to what could be a valid page path in ProcessWire * @method string pagePathName($varName) Sanitize to what could be a valid page path in ProcessWire
* @method string email($varName) Sanitize email address, converting to blank if invalid * @method string email($varName) Sanitize email address, converting to blank if invalid
* @method string emailHeader($varName) Sanitize string for use in an email header * @method string emailHeader($varName) Sanitize string for use in an email header
* @method string text($varName) Sanitize to single line of text up to 255 characters (1024 bytes max), HTML markup is removed * @method string text($varName, $options = array()) Sanitize to single line of text up to 255 characters (1024 bytes max), HTML markup is removed
* @method string textarea($varName) Sanitize to multi-line text up to 16k characters (48k bytes), HTML markup is removed * @method string textarea($varName) Sanitize to multi-line text up to 16k characters (48k bytes), HTML markup is removed
* @method string url($varName) Sanitize to a valid URL, or convert to blank if it can't be sanitized * @method string url($varName) Sanitize to a valid URL, or convert to blank if it can't be sanitized
* @method string selectorField($varName) Sanitize a field name for use in a selector string * @method string selectorField($varName) Sanitize a field name for use in a selector string

16
wire/modules/Process/ProcessPageLister/ProcessPageListerBookmarks.php
View File

@@ -312,8 +312,14 @@ class ProcessPageListerBookmarks extends Wire {
$f->label = $this->_x('What pages should this bookmark show?', 'bookmark-editor'); $f->label = $this->_x('What pages should this bookmark show?', 'bookmark-editor');
$selector = $bookmark['selector']; $selector = $bookmark['selector'];
if($bookmark['sort']) $selector .= ", sort=$bookmark[sort]"; if($bookmark['sort']) $selector .= ", sort=$bookmark[sort]";
if($this->lister->initSelector && strpos($selector, $this->lister->initSelector) !== false) { if($this->lister->initSelector) {
$selector = str_replace($this->lister->initSelector, '', $selector); // ensure that $selector does not contain initSelector $initSelector = $this->lister->initSelector;
if(strpos($selector, $initSelector) === false) {
$initSelector = trim(preg_replace('![,\s]*\binclude=(all|unpublished|hidden)\b!i', '', $initSelector), ', ');
}
if(strpos($selector, $initSelector) !== false) {
$selector = str_replace($initSelector, '', $selector); // ensure that $selector does not contain initSelector
}
} }
if($this->lister->template) $f->initTemplate = $this->lister->template; if($this->lister->template) $f->initTemplate = $this->lister->template;
$default = $this->lister->className() == 'ProcessPageLister'; $default = $this->lister->className() == 'ProcessPageLister';
@@ -483,9 +489,9 @@ class ProcessPageListerBookmarks extends Wire {
*/ */
protected function executeSaveBookmark() { protected function executeSaveBookmark() {
$input = $this->wire('input'); $input = $this->wire()->input;
$sanitizer = $this->wire('sanitizer'); $sanitizer = $this->wire()->sanitizer;
$languages = $this->wire('languages'); $languages = $this->wire()->languages;
$bookmarkID = $this->bookmarks->_bookmarkID($input->post('bookmark_id')); $bookmarkID = $this->bookmarks->_bookmarkID($input->post('bookmark_id'));
$bookmarkTitle = $input->post->text('bookmark_title'); $bookmarkTitle = $input->post->text('bookmark_title');

61
wire/modules/Process/ProcessPageType/ProcessPageType.module
View File

@@ -8,7 +8,7 @@
* For more details about how Process modules work, please see: * For more details about how Process modules work, please see:
* /wire/core/Process.php * /wire/core/Process.php
* *
* ProcessWire 3.x, Copyright 2018 by Ryan Cramer * ProcessWire 3.x, Copyright 2020 by Ryan Cramer
* https://processwire.com * https://processwire.com
* *
* @property array $showFields Names of fields to show in the main list table (default=['name']) * @property array $showFields Names of fields to show in the main list table (default=['name'])
@@ -62,6 +62,14 @@ class ProcessPageType extends Process implements ConfigurableModule, WirePageEdi
*/ */
protected $lister = null; protected $lister = null;
/**
* Requested Lister bookmark ID (when applicable)
*
* @var string|null|bool
*
*/
protected $listerBookmarkID = '';
/** /**
* Construct * Construct
* *
@@ -115,9 +123,10 @@ class ProcessPageType extends Process implements ConfigurableModule, WirePageEdi
*/ */
protected function initLister() { protected function initLister() {
if(!$this->useLister()) return; if(!$this->useLister() || $this->lister) return;
// init lister, but only if executing an action that will use it // init lister, but only if executing an action that will use it
$modules = $this->wire()->modules;
$segment = $this->wire('input')->urlSegment1; $segment = $this->wire('input')->urlSegment1;
$user = $this->wire('user'); $user = $this->wire('user');
$listerSegments = array( $listerSegments = array(
@@ -129,14 +138,32 @@ class ProcessPageType extends Process implements ConfigurableModule, WirePageEdi
'save', 'save',
'edit-bookmark', 'edit-bookmark',
); );
if(empty($segment) || in_array($segment, $listerSegments) && $user->hasPermission('page-lister')) {
if($this->wire('modules')->isInstalled('ProcessPageListerPro')) { if(strpos($segment, 'bm') === 0 && preg_match('/^bm[0-9O]+$/', $segment)) {
$this->lister = $this->wire('modules')->get('ProcessPageListerPro'); // bookmark ID, i.e. users/bm42O1604139292
$bookmarkID = $segment;
} else {
$bookmarkID = '';
} }
if((!$this->lister || !$this->lister->isValid()) && $this->wire('modules')->isInstalled('ProcessPageLister')) {
$this->lister = $this->wire('modules')->get('ProcessPageLister'); if(empty($segment) || $bookmarkID || in_array($segment, $listerSegments)) {
if(!$user->hasPermission('page-lister')) return;
if($modules->isInstalled('ProcessPageListerPro')) {
$this->lister = $modules->get('ProcessPageListerPro');
if($this->lister && method_exists($this->lister, 'isValid') && !$this->lister->isValid()) {
$this->lister = null;
} }
} }
if(!$this->lister && $modules->isInstalled('ProcessPageLister')) {
$this->lister = $modules->get('ProcessPageLister');
}
}
if($this->lister && $bookmarkID) {
$bookmarks = $this->lister->getBookmarksInstance();
$bookmarkID = $bookmarks->_bookmarkID(ltrim($bookmarkID, 'bm'));
$this->listerBookmarkID = $this->lister->checkBookmark($bookmarkID);
}
} }
// Lister-specific methods, all mapped directly to Lister or ListerPro // Lister-specific methods, all mapped directly to Lister or ListerPro
@@ -147,6 +174,24 @@ class ProcessPageType extends Process implements ConfigurableModule, WirePageEdi
public function ___executeSave() { return $this->getLister()->executeSave(); } public function ___executeSave() { return $this->getLister()->executeSave(); }
public function ___executeEditBookmark() { return $this->getLister()->executeEditBookmark(); } public function ___executeEditBookmark() { return $this->getLister()->executeEditBookmark(); }
/**
* Catch-all for bookmarks
*
* @return string
* @throws Wire404Exception
* @throws WireException
*
*/
public function ___executeUnknown() {
$lister = null;
if($this->useLister()) {
$this->initLister();
$lister = $this->getLister();
if($lister && $this->listerBookmarkID) return $lister->executeUnknown();
}
throw new Wire404Exception("Unknown action", Wire404Exception::codeNonexist);
}
/** /**
* Main execution method, delegated to listing items in this page type * Main execution method, delegated to listing items in this page type
* *
@@ -259,7 +304,7 @@ class ProcessPageType extends Process implements ConfigurableModule, WirePageEdi
'delimiters' => array(), 'delimiters' => array(),
'allowSystem' => true, 'allowSystem' => true,
'allowIncludeAll' => true, 'allowIncludeAll' => true,
'allowBookmarks' => false, 'allowBookmarks' => true,
'showIncludeWarnings' => false, 'showIncludeWarnings' => false,
'toggles' => array('collapseFilters'), 'toggles' => array('collapseFilters'),
); );

33
wire/modules/Process/ProcessUser/ProcessUser.module
View File

@@ -6,7 +6,7 @@
* For more details about how Process modules work, please see: * For more details about how Process modules work, please see:
* /wire/core/Process.php * /wire/core/Process.php
* *
* ProcessWire 3.x, Copyright 2016 by Ryan Cramer * ProcessWire 3.x, Copyright 2020 by Ryan Cramer
* https://processwire.com * https://processwire.com
* *
* @property int $maxAjaxQty * @property int $maxAjaxQty
@@ -107,9 +107,10 @@ class ProcessUser extends ProcessPageType {
*/ */
public function hookListerExecute($event) { public function hookListerExecute($event) {
$role = (int) $this->wire('session')->get($this, 'listerRole'); $role = (int) $this->wire()->session->getFor($this, 'listerRole');
if(!$role) return; if(!$role) return;
/** @var ProcessPageLister $lister */
$lister = $event->object; $lister = $event->object;
$defaultSelector = $lister->defaultSelector; $defaultSelector = $lister->defaultSelector;
if(strpos($defaultSelector, 'roles=') !== false) { if(strpos($defaultSelector, 'roles=') !== false) {
@@ -132,25 +133,25 @@ class ProcessUser extends ProcessPageType {
$settings = parent::getListerSettings($lister, $selector); $settings = parent::getListerSettings($lister, $selector);
$selector = ''; $selector = '';
$role = (int) $this->wire('input')->get('roles'); $role = (int) $this->wire()->input->get('roles');
$user = $this->wire('user'); $user = $this->wire()->user;
$session = $this->wire('session'); $session = $this->wire()->session;
$ajax = $this->wire('config')->ajax; $ajax = $this->wire('config')->ajax;
if($role) { if($role) {
$lister->resetLister(); $lister->resetLister();
$session->set($this, 'listerRole', $role); $session->setFor($this, 'listerRole', $role);
} else if(!$ajax) { } else if(!$ajax) {
if((int) $session->get($this, 'listerRole') > 0) { if((int) $session->getFor($this, 'listerRole') > 0) {
$lister->resetLister(); $lister->resetLister();
$session->set($this, 'listerRole', 0); $session->setFor($this, 'listerRole', 0);
} }
} else { } else {
$role = $session->get($this, 'listerRole'); $role = $session->getFor($this, 'listerRole');
} }
if(!$role && !$user->isSuperuser()) { if(!$role && !$user->isSuperuser()) {
$userAdminAll = $this->wire('permissions')->get('user-admin-all'); $userAdminAll = $this->wire()->permissions->get('user-admin-all');
if($userAdminAll->id && !$user->hasPermission($userAdminAll)) { if($userAdminAll->id && !$user->hasPermission($userAdminAll)) {
// system has user-admin-all permission, and user doesn't have it // system has user-admin-all permission, and user doesn't have it
// so limit them only to the permission user-admin-[role] roles that they have assigned // so limit them only to the permission user-admin-[role] roles that they have assigned
@@ -162,8 +163,9 @@ class ProcessUser extends ProcessPageType {
if($rolePage->id) $roles[] = $rolePage->id; if($rolePage->id) $roles[] = $rolePage->id;
} }
// allow them to view users that only have guest role // allow them to view users that only have guest role
$guestRoleID = $this->wire('config')->guestUserRolePageID; $config = $this->wire()->config;
$guestUserID = $this->wire('config')->guestUserPageID; $guestRoleID = $config->guestUserRolePageID;
$guestUserID = $config->guestUserPageID;
$selector .= ", id!=$guestUserID, roles=(roles.count=1, roles=$guestRoleID)"; $selector .= ", id!=$guestUserID, roles=(roles.count=1, roles=$guestRoleID)";
if(count($roles)) { if(count($roles)) {
$selector .= ", roles=(roles=" . implode('|', $roles) . ")"; // string of | separated role IDs $selector .= ", roles=(roles=" . implode('|', $roles) . ")"; // string of | separated role IDs
@@ -174,6 +176,7 @@ class ProcessUser extends ProcessPageType {
$settings['initSelector'] .= $selector; $settings['initSelector'] .= $selector;
$settings['defaultSelector'] = "name%=, roles=" . ($role ? $role : ''); $settings['defaultSelector'] = "name%=, roles=" . ($role ? $role : '');
$settings['delimiters'] = array('roles' => ', '); $settings['delimiters'] = array('roles' => ', ');
$settings['allowBookmarks'] = true;
return $settings; return $settings;
} }
@@ -287,8 +290,10 @@ class ProcessUser extends ProcessPageType {
* *
*/ */
public function hookGetSelectablePages($event) { public function hookGetSelectablePages($event) {
if($event->object->attr('name') != 'roles') return; /** @var InputfieldPage $inputfield */
$suRoleID = $this->wire('config')->superUserRolePageID; $inputfield = $event->object;
if($inputfield->attr('name') != 'roles') return;
$suRoleID = $this->wire()->config->superUserRolePageID;
foreach($event->return as $role) { foreach($event->return as $role) {
if($role->id == $suRoleID) $event->return->remove($role); if($role->id == $suRoleID) $event->return->remove($role);
} }