*/
// must be run within Dokuwiki
if(!defined('DOKU_INC')) die();
use dokuwiki\plugin\struct\meta\AccessTable;
use dokuwiki\plugin\struct\meta\Assignments;
use dokuwiki\plugin\struct\meta\ValidationResult;
use dokuwiki\plugin\struct\meta\Value;
/**
* Class action_plugin_struct_entry
*
* Handles the whole struct data entry process
*/
class action_plugin_struct_entry extends DokuWiki_Action_Plugin {
/**
* @var string The form name we use to transfer schema data
*/
protected static $VAR = 'struct_schema_data';
/** @var helper_plugin_sqlite */
protected $sqlite;
/** @var bool has the data been validated correctly? */
protected $validated;
/** @var ValidationResult[] these schemas are validated and have changed data and need to be saved */
protected $tosave;
/**
* Registers a callback function for a given event
*
* @param Doku_Event_Handler $controller DokuWiki's event controller object
* @return void
*/
public function register(Doku_Event_Handler $controller) {
// validate data on preview and save;
$controller->register_hook('ACTION_ACT_PREPROCESS', 'BEFORE', $this, 'handle_validation');
// ensure a page revision is created when struct data changes:
$controller->register_hook('COMMON_WIKIPAGE_SAVE', 'BEFORE', $this, 'handle_pagesave_before');
// save struct data after page has been saved:
$controller->register_hook('COMMON_WIKIPAGE_SAVE', 'AFTER', $this, 'handle_pagesave_after');
}
/**
* Clean up and validate the input data
*
* @param Doku_Event $event event object by reference
* @param mixed $param [the parameters passed as fifth argument to register_hook() when this
* handler was registered]
* @return bool
*/
public function handle_validation(Doku_Event $event, $param) {
global $ID, $INPUT;
$act = act_clean($event->data);
if(!in_array($act, array('save', 'preview'))) return false;
// run the validation for each assignded schema
$input = $INPUT->arr(self::$VAR);
$this->validated = true;
$assignments = new Assignments();
$tables = $assignments->getPageAssignments($ID);
foreach($tables as $table) {
$access = AccessTable::byTableName($table, $ID);
$validation = $access->getValidator($input[$table]);
if(!$validation->validate()) {
$this->validated = false;
foreach($validation->getErrors() as $error) {
msg(hsc($error), -1);
}
} else {
if($validation->hasChanges()) {
$this->tosave[] = $validation;
}
}
}
// FIXME we used to set the cleaned data as new input data. this caused #140
// could we just not do that, and keep the cleaning to saving only? and fix that bug this way?
// did validation go through? otherwise abort saving
if(!$this->validated && $act == 'save') {
$event->data = 'edit';
}
return true;
}
/**
* Check if the page has to be changed
*
* @param Doku_Event $event event object by reference
* @param mixed $param [the parameters passed as fifth argument to register_hook() when this
* handler was registered]
* @return bool
*/
public function handle_pagesave_before(Doku_Event $event, $param) {
if($event->data['contentChanged']) return false; // will be saved for page changes
global $ACT;
if($ACT == 'revert') return false; // this is handled in revert.php
if(count($this->tosave) || isset($GLOBALS['struct_plugin_force_page_save'])) {
if(trim($event->data['newContent']) === '') {
// this happens when a new page is tried to be created with only struct data
msg($this->getLang('emptypage'), -1);
} else {
$event->data['contentChanged'] = true; // save for data changes
// add a summary
if(empty($event->data['summary'])) {
$event->data['summary'] = $this->getLang('summary');
}
}
}
return true;
}
/**
* Save the data
*
* When this is called, INPUT data has been validated already.
*
* @param Doku_Event $event event object by reference
* @param mixed $param [the parameters passed as fifth argument to register_hook() when this
* handler was registered]
* @return bool
*/
public function handle_pagesave_after(Doku_Event $event, $param) {
global $ACT;
if($ACT == 'revert') return false; // handled in revert
$assignments = new Assignments();
if($event->data['changeType'] == DOKU_CHANGE_TYPE_DELETE && empty($GLOBALS['PLUGIN_MOVE_WORKING'])) {
// clear all data on delete unless it's a move operation
$tables = $assignments->getPageAssignments($event->data['id']);
foreach($tables as $table) {
$schemaData = AccessTable::byTableName($table, $event->data['id'], time());
$schemaData->clearData();
}
} else {
// save the provided data
if($this->tosave) foreach($this->tosave as $validation) {
$validation->saveData($event->data['newRevision']);
// make sure this schema is assigned
$assignments->assignPageSchema(
$event->data['id'],
$validation->getAccessTable()->getSchema()->getTable()
);
}
}
return true;
}
/**
* Create the form to edit schemadata
*
* @param string $tablename
* @return string The HTML for this schema's form
*/
protected function createForm($tablename) {
global $ID;
global $REV;
global $INPUT;
if(auth_quickaclcheck($ID) == AUTH_READ) return '';
if(checklock($ID)) return '';
$schema = AccessTable::byTableName($tablename, $ID, $REV);
$schemadata = $schema->getData();
$structdata = $INPUT->arr(self::$VAR);
if(isset($structdata[$tablename])) {
$postdata = $structdata[$tablename];
} else {
$postdata = array();
}
// we need a short, unique identifier to use in the cookie. this should be good enough
$schemaid = 'SRCT' . substr(str_replace(array('+', '/'), '', base64_encode(sha1($tablename, true))), 0, 5);
$html = '';
return $html;
}
/**
* Create the input field
*
* @param Value $field
* @param String $name field's name
* @return string
*/
public function makeField(Value $field, $name) {
$trans = hsc($field->getColumn()->getTranslatedLabel());
$hint = hsc($field->getColumn()->getTranslatedHint());
$class = $hint ? 'hashint' : '';
$colname = $field->getColumn()->getFullQualifiedLabel();
$input = $field->getValueEditor($name);
// we keep all the custom form stuff the field might produce, but hide it
if(!$field->getColumn()->isVisibleInEditor()) {
$hide = 'style="display:none"';
} else {
$hide = '';
}
$html = '';
$html .= "';
return $html;
}
}
// vim:ts=4:sw=4:et: