Skip to content

Cleanup #48

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Klap-in wants to merge 14 commits into
base: master
Choose a base branch
from
Open

Cleanup #48

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
fffba16
refactor perm check
Klap-in Sep 7, 2022
54067a0
replace deprecated trigger_event
Klap-in Sep 7, 2022
907153e
add missing perm info
Klap-in Sep 7, 2022
168a1d1
helper reformatting
Klap-in Sep 7, 2022
944e1d4
helper visibility and rename
Klap-in Sep 7, 2022
d57a637
rename helper
Klap-in Sep 7, 2022
30e72cd
rename, reformat, remove duplicate file exists
Klap-in Sep 7, 2022
624860f
fix typo
Klap-in Sep 13, 2022
631d583
fix php8 warnings
Klap-in Sep 13, 2022
3b51d96
ics.php: cleanup duplicated requires, little refactoring
Klap-in Sep 13, 2022
f8cf87e
reformatting, phpdocs, renaming, visibility, removed unused vars
Klap-in Sep 13, 2022
217f164
fix use of helper, phpdocs, php 8 warning, refactoring, renaming
Klap-in Sep 13, 2022
c1bef39
use $INPUT, reformatting, phpdocs
Klap-in Oct 20, 2022
1e72c2e
use new helper functions of pagelist plugin, deprecated old
Klap-in Oct 20, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
99 changes: 53 additions & 46 deletions action.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,51 +9,49 @@ class action_plugin_task extends DokuWiki_Action_Plugin {
/**
* register the eventhandlers
*/
function register(Doku_Event_Handler $contr) {
$contr->register_hook('ACTION_ACT_PREPROCESS',
'BEFORE',
$this,
'handle_act_preprocess',
array());
public function register(Doku_Event_Handler $controller) {
$controller->register_hook('ACTION_ACT_PREPROCESS', 'BEFORE', $this, 'handleTaskActions', []);
}

/**
* Checks if 'newentry' was given as action, if so we
* do handle the event our self and no further checking takes place
*
* @param Doku_Event $event
* @param $param
*/
function handle_act_preprocess(&$event, $param) {
public function handleTaskActions($event, $param) {
if ($event->data != 'newtask' && $event->data != 'changetask') return;

// we can handle it -> prevent others
$event->stopPropagation();

switch($event->data) {
case 'newtask':
$event->data = $this->_newTask();
$event->data = $this->newTask();
break;
case 'changetask':
$event->data = $this->_changeTask();
$event->data = $this->changeTask();
break;
}
}

/**
* Creates a new task page
*/
function _newTask() {
global $ID;
global $INFO;
protected function newTask() {
global $ID, $INFO, $INPUT;

$ns = cleanID($_REQUEST['ns']);
$title = str_replace(':', '', $_REQUEST['title']);
$ns = cleanID($INPUT->post->str('ns'));
$title = str_replace(':', '', $INPUT->post->str('title'));
$back = $ID;
$ID = ($ns ? $ns.':' : '').cleanID($title);
$INFO = pageinfo();

// check if we are allowed to create this file
if ($INFO['perm'] >= AUTH_CREATE) {

//check if locked by anyone - if not lock for my self
//check if locked by anyone - if not lock for my self
if ($INFO['locked']) {
return 'locked';
} else {
Expand All @@ -64,20 +62,20 @@ function _newTask() {
if (!@file_exists($INFO['filepath'])) {
global $TEXT;

$user = $_REQUEST['user'];
$date = $_REQUEST['date'];
$priority = $_REQUEST['priority'];
$user = $INPUT->post->str('user');
$date = $INPUT->post->str('date');
$priority = $INPUT->post->str('priority');

// create wiki page
$data = array(
$data = [
'id' => $ID,
'ns' => $ns,
'title' => $title,
'back' => $back,
'priority' => $priority,
'user' => $user,
'date' => $date,
);
];

$TEXT = $this->_pageTemplate($data);
return 'preview';
Expand All @@ -88,9 +86,20 @@ function _newTask() {
return 'show';
}
}

/**
* Adapted version of pageTemplate() function
*
* @param array $data with:
* 'id' => string page id,
* 'ns' => string namespace,
* 'user' => string user id,
* 'date' => string date Y-m-d,
* 'back' => string page id of page to go back to,
* 'title' => string page title,
* 'priority' => string zero to three exclamation marks(!)
*
* @return string raw wiki text
*/
function _pageTemplate($data) {
global $INFO;
Expand All @@ -99,50 +108,48 @@ function _pageTemplate($data) {
$tpl = io_readFile(DOKU_PLUGIN.'task/_template.txt');

// standard replacements
$replace = array(
$replace = [
'@ID@' => $id,
'@NS@' => $data['ns'],
'@PAGE@' => strtr(noNS($id),'_',' '),
'@USER@' => $data['user'],
'@NAME@' => $INFO['userinfo']['name'],
'@MAIL@' => $INFO['userinfo']['mail'],
'@DATE@' => $data['date'],
);
];

// additional replacements
$replace['@BACK@'] = $data['back'];
$replace['@TITLE@'] = $data['title'];
$replace['@PRIORITY@'] = $data['priority'];

// tag if tag plugin is available
if ((@file_exists(DOKU_PLUGIN.'tag/syntax/tag.php')) && (!plugin_isdisabled('tag'))) {
if (!plugin_isdisabled('tag')) {
$replace['@TAG@'] = "\n\n{{tag>}}";
} else {
$replace['@TAG@'] = '';
}

// discussion if discussion plugin is available
if ((@file_exists(DOKU_PLUGIN.'discussion/syntax/comments.php')) && (!plugin_isdisabled('discussion'))) {
if (!plugin_isdisabled('discussion')) {
$replace['@DISCUSSION@'] = "~~DISCUSSION~~";
} else {
$replace['@DISCUSSION@'] = '';
}

// do the replace
$tpl = str_replace(array_keys($replace), array_values($replace), $tpl);
return $tpl;
return str_replace(array_keys($replace), array_values($replace), $tpl);
}

/**
* Changes the status of a task
*/
function _changeTask() {
global $ID;
global $INFO;
protected function changeTask() {
global $ID, $INFO, $INPUT;

$status = $_REQUEST['status'];
$status = $INPUT->post->int('status'); //TODO check if other default then 0?
$status = trim($status);
if (!is_numeric($status) || ($status < -1) || ($status > 4)) {
if (!is_numeric($status) || $status < -1 || $status > 4) { //FIXME is_numeric not needed
if ($this->getConf('show_error_msg')) {
$message = $this->getLang('msg_rcvd_invalid_status');
$message = str_replace('%status%', $status, $message);
Expand All @@ -152,8 +159,9 @@ function _changeTask() {
}

// load task data
if ($my =& plugin_load('helper', 'task')) {
$task = $my->readTask($ID);
/** @var helper_plugin_task $helper */
if ($helper = $this->loadHelper('task', false)) {
$task = $helper->readTask($ID);
} else {
if ($this->getConf('show_error_msg')) {
msg($this->getLang('msg_load_helper_failed'), -1);
Expand All @@ -169,14 +177,14 @@ function _changeTask() {
return 'show';
}

$responsible = $my->_isResponsible($task['user']['name']);
$responsible = $helper->isResponsible($task['user']['name']);

// some additional checks if change not performed by an admin
// FIXME error messages?
if ($INFO['perm'] != AUTH_ADMIN) {

// responsible person can't verify her / his own tasks
if ($responsible && ($status == 4)) {
if ($responsible && $status == 4) {
if ($this->getConf('show_info_msg')) {
msg ($this->getLang('msg_responsible_no_verify'));
}
Expand All @@ -195,7 +203,7 @@ function _changeTask() {
// assign task to a user
if (!$task['user']['name']) {
// FIXME error message?
if (!$_SERVER['REMOTE_USER']) {
if (!$INPUT->server->has('REMOTE_USER')) {
// no logged in user
if ($this->getConf('show_info_msg')) {
msg($this->getLang('msg_not_logged_in'));
Expand All @@ -211,27 +219,26 @@ function _changeTask() {
saveWikiText($ID, $new, $summary, true); // save as minor edit
}

$task['user'] = array(
'id' => $_SERVER['REMOTE_USER'],
$task['user'] = [
'id' => $INPUT->server->str('REMOTE_USER'),
'name' => $INFO['userinfo']['name'],
'mail' => $INFO['userinfo']['mail'],
);
];
}

// save .task meta file and clear xhtml cache
$oldstatus = $task['status'];
$task['status'] = $status;
$my->writeTask($ID, $task);
$_REQUEST['purge'] = true;
$helper->writeTask($ID, $task);
$INPUT->set('purge', true);

if ($this->getConf('show_success_msg')) {
$message = $this->getLang('msg_status_changed');
$message = str_replace('%status%', $my->statusLabel($status), $message);
$message = str_replace('%oldstatus%', $my->statusLabel($oldstatus), $message);
$message = str_replace('%status%', $helper->statusLabel($status), $message);
$message = str_replace('%oldstatus%', $helper->statusLabel($oldstatus), $message);
msg($message, 1);
}

return 'show';
}
}
// vim:ts=4:sw=4:et:enc=utf-8:
Loading