From b2c9cd19ff3733a632c8d415256d3096765343f7 Mon Sep 17 00:00:00 2001
From: Andreas Gohr <gohr@cosmocode.de>
Date: Thu, 12 Apr 2018 15:36:43 +0200
Subject: [PATCH] renamed ActionRouter::checkPermissions to checkPreconditions
As discussed in #1933
---
_test/tests/inc/Action/general.test.php | 8 ++++----
inc/Action/AbstractAclAction.php | 4 ++--
inc/Action/AbstractAction.php | 4 ++--
inc/Action/AbstractUserAction.php | 4 ++--
inc/Action/Admin.php | 4 ++--
inc/Action/Draft.php | 4 ++--
inc/Action/Edit.php | 4 ++--
inc/Action/Login.php | 4 ++--
inc/Action/Logout.php | 4 ++--
inc/Action/Profile.php | 4 ++--
inc/Action/ProfileDelete.php | 4 ++--
inc/Action/Register.php | 4 ++--
inc/Action/Resendpwd.php | 4 ++--
inc/Action/Search.php | 4 ++--
inc/Action/Subscribe.php | 4 ++--
inc/ActionRouter.php | 2 +-
16 files changed, 33 insertions(+), 33 deletions(-)
diff --git a/_test/tests/inc/Action/general.test.php b/_test/tests/inc/Action/general.test.php
index 5e6402836..9aacfbf96 100644
--- a/_test/tests/inc/Action/general.test.php
+++ b/_test/tests/inc/Action/general.test.php
@@ -133,7 +133,7 @@ class action_general extends DokuWikiTest {
$conf['subscribers'] = 1;
try {
- $class->checkPermissions();
+ $class->checkPreconditions();
} catch(\Exception $e) {
$this->assertNotSame(ActionAclRequiredException::class, get_class($e));
}
@@ -141,7 +141,7 @@ class action_general extends DokuWikiTest {
$conf['useacl'] = 0;
try {
- $class->checkPermissions();
+ $class->checkPreconditions();
} catch(\Exception $e) {
$this->assertSame(ActionAclRequiredException::class, get_class($e));
}
@@ -166,7 +166,7 @@ class action_general extends DokuWikiTest {
$_SERVER['REMOTE_USER'] = 'test';
try {
- $class->checkPermissions();
+ $class->checkPreconditions();
} catch(\Exception $e) {
$this->assertNotSame(ActionUserRequiredException::class, get_class($e));
}
@@ -174,7 +174,7 @@ class action_general extends DokuWikiTest {
unset($_SERVER['REMOTE_USER']);
try {
- $class->checkPermissions();
+ $class->checkPreconditions();
} catch(\Exception $e) {
$this->assertSame(ActionUserRequiredException::class, get_class($e));
}
diff --git a/inc/Action/AbstractAclAction.php b/inc/Action/AbstractAclAction.php
index 76639b066..871edb0ae 100644
--- a/inc/Action/AbstractAclAction.php
+++ b/inc/Action/AbstractAclAction.php
@@ -14,8 +14,8 @@ use dokuwiki\Action\Exception\ActionAclRequiredException;
abstract class AbstractAclAction extends AbstractAction {
/** @inheritdoc */
- public function checkPermissions() {
- parent::checkPermissions();
+ public function checkPreconditions() {
+ parent::checkPreconditions();
global $conf;
global $auth;
if(!$conf['useacl']) throw new ActionAclRequiredException();
diff --git a/inc/Action/AbstractAction.php b/inc/Action/AbstractAction.php
index 8c2467f86..ea862386e 100644
--- a/inc/Action/AbstractAction.php
+++ b/inc/Action/AbstractAction.php
@@ -44,12 +44,12 @@ abstract class AbstractAction {
abstract public function minimumPermission();
/**
- * Check permissions are correct to run this action
+ * Check conditions are met to run this action
*
* @throws ActionException
* @return void
*/
- public function checkPermissions() {
+ public function checkPreconditions() {
}
/**
diff --git a/inc/Action/AbstractUserAction.php b/inc/Action/AbstractUserAction.php
index 8a3a19f75..b4e3f1a4d 100644
--- a/inc/Action/AbstractUserAction.php
+++ b/inc/Action/AbstractUserAction.php
@@ -14,8 +14,8 @@ use dokuwiki\Action\Exception\ActionUserRequiredException;
abstract class AbstractUserAction extends AbstractAclAction {
/** @inheritdoc */
- public function checkPermissions() {
- parent::checkPermissions();
+ public function checkPreconditions() {
+ parent::checkPreconditions();
global $INPUT;
if(!$INPUT->server->str('REMOTE_USER')) {
throw new ActionUserRequiredException();
diff --git a/inc/Action/Admin.php b/inc/Action/Admin.php
index b1f9095ee..8d4305788 100644
--- a/inc/Action/Admin.php
+++ b/inc/Action/Admin.php
@@ -24,8 +24,8 @@ class Admin extends AbstractUserAction {
}
}
- public function checkPermissions() {
- parent::checkPermissions();
+ public function checkPreconditions() {
+ parent::checkPreconditions();
global $INFO;
if(!$INFO['ismanager']) {
diff --git a/inc/Action/Draft.php b/inc/Action/Draft.php
index ab678c294..caf087011 100644
--- a/inc/Action/Draft.php
+++ b/inc/Action/Draft.php
@@ -25,8 +25,8 @@ class Draft extends AbstractAction {
}
/** @inheritdoc */
- public function checkPermissions() {
- parent::checkPermissions();
+ public function checkPreconditions() {
+ parent::checkPreconditions();
global $INFO;
if(!file_exists($INFO['draft'])) throw new ActionException('edit');
}
diff --git a/inc/Action/Edit.php b/inc/Action/Edit.php
index 748351681..061c9e2ca 100644
--- a/inc/Action/Edit.php
+++ b/inc/Action/Edit.php
@@ -26,8 +26,8 @@ class Edit extends AbstractAction {
/**
* @inheritdoc falls back to 'source' if page not writable
*/
- public function checkPermissions() {
- parent::checkPermissions();
+ public function checkPreconditions() {
+ parent::checkPreconditions();
global $INFO;
// no edit permission? view source
diff --git a/inc/Action/Login.php b/inc/Action/Login.php
index 6e4aeb01a..7f903ff2d 100644
--- a/inc/Action/Login.php
+++ b/inc/Action/Login.php
@@ -19,9 +19,9 @@ class Login extends AbstractAclAction {
}
/** @inheritdoc */
- public function checkPermissions() {
+ public function checkPreconditions() {
global $INPUT;
- parent::checkPermissions();
+ parent::checkPreconditions();
if($INPUT->server->has('REMOTE_USER')) {
// nothing to do
throw new ActionException();
diff --git a/inc/Action/Logout.php b/inc/Action/Logout.php
index 2abf968f6..159090423 100644
--- a/inc/Action/Logout.php
+++ b/inc/Action/Logout.php
@@ -20,8 +20,8 @@ class Logout extends AbstractUserAction {
}
/** @inheritdoc */
- public function checkPermissions() {
- parent::checkPermissions();
+ public function checkPreconditions() {
+ parent::checkPreconditions();
/** @var \DokuWiki_Auth_Plugin $auth */
global $auth;
diff --git a/inc/Action/Profile.php b/inc/Action/Profile.php
index 1ebe51fec..53d8d2ff3 100644
--- a/inc/Action/Profile.php
+++ b/inc/Action/Profile.php
@@ -20,8 +20,8 @@ class Profile extends AbstractUserAction {
}
/** @inheritdoc */
- public function checkPermissions() {
- parent::checkPermissions();
+ public function checkPreconditions() {
+ parent::checkPreconditions();
/** @var \DokuWiki_Auth_Plugin $auth */
global $auth;
diff --git a/inc/Action/ProfileDelete.php b/inc/Action/ProfileDelete.php
index 5be5ff578..995f81394 100644
--- a/inc/Action/ProfileDelete.php
+++ b/inc/Action/ProfileDelete.php
@@ -20,8 +20,8 @@ class ProfileDelete extends AbstractUserAction {
}
/** @inheritdoc */
- public function checkPermissions() {
- parent::checkPermissions();
+ public function checkPreconditions() {
+ parent::checkPreconditions();
/** @var \DokuWiki_Auth_Plugin $auth */
global $auth;
diff --git a/inc/Action/Register.php b/inc/Action/Register.php
index c97d3f858..0d5415868 100644
--- a/inc/Action/Register.php
+++ b/inc/Action/Register.php
@@ -20,8 +20,8 @@ class Register extends AbstractAclAction {
}
/** @inheritdoc */
- public function checkPermissions() {
- parent::checkPermissions();
+ public function checkPreconditions() {
+ parent::checkPreconditions();
/** @var \DokuWiki_Auth_Plugin $auth */
global $auth;
diff --git a/inc/Action/Resendpwd.php b/inc/Action/Resendpwd.php
index 80f05e056..ab243b042 100644
--- a/inc/Action/Resendpwd.php
+++ b/inc/Action/Resendpwd.php
@@ -20,8 +20,8 @@ class Resendpwd extends AbstractAclAction {
}
/** @inheritdoc */
- public function checkPermissions() {
- parent::checkPermissions();
+ public function checkPreconditions() {
+ parent::checkPreconditions();
/** @var \DokuWiki_Auth_Plugin $auth */
global $auth;
diff --git a/inc/Action/Search.php b/inc/Action/Search.php
index aa19671da..382fc47e6 100644
--- a/inc/Action/Search.php
+++ b/inc/Action/Search.php
@@ -27,8 +27,8 @@ class Search extends AbstractAction {
*
* @inheritdoc
*/
- public function checkPermissions() {
- parent::checkPermissions();
+ public function checkPreconditions() {
+ parent::checkPreconditions();
}
public function preProcess()
diff --git a/inc/Action/Subscribe.php b/inc/Action/Subscribe.php
index 94920c428..c16571022 100644
--- a/inc/Action/Subscribe.php
+++ b/inc/Action/Subscribe.php
@@ -20,8 +20,8 @@ class Subscribe extends AbstractUserAction {
}
/** @inheritdoc */
- public function checkPermissions() {
- parent::checkPermissions();
+ public function checkPreconditions() {
+ parent::checkPreconditions();
global $conf;
if(isset($conf['subscribers']) && !$conf['subscribers']) throw new ActionDisabledException();
diff --git a/inc/ActionRouter.php b/inc/ActionRouter.php
index 7e6fddd16..edc45cfc4 100644
--- a/inc/ActionRouter.php
+++ b/inc/ActionRouter.php
@@ -204,7 +204,7 @@ class ActionRouter {
throw new ActionDisabledException();
}
- $action->checkPermissions();
+ $action->checkPreconditions();
if(isset($INFO)) {
$perm = $INFO['perm'];
--
GitLab