* @author Cornelius Weiss * @package admin * @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License * @version $Id$ */ use EGroupware\Api; use EGroupware\Api\Framework; use EGroupware\Api\Etemplate; /** * Customfields class - manages custom-field definitions in egw_customfields table through Api\Storage\Customfields class. * * Applications can have customfields by sub-type by having a template * named '.admin.types'. See admin.customfields.types as an * example, but the template can even be empty if types are handled by the * application in another way. * * Applications can extend this class to customize the custom fields and handle * extra information from the above template by extending and implementing * update() and app_index(). */ class admin_customfields { /** * appname of app which want to add / edit its customfields * * @var string */ var $appname; /** * Allow custom fields to be restricted to certain users/groups */ protected $use_private = false; /** * Allow custom fields to be readonly for certain users/groups */ protected $use_readonly = false; /** * userdefiened types e.g. type of infolog * * @var array */ var $types2 = array(); var $content_types,$fields; /** * Does App uses content-types * * @var boolean */ protected $manage_content_types = false; /** * Currently selected content type (if used by app) * @var string */ protected $content_type = null; var $public_functions = array( 'index' => true, 'edit' => True ); /** * Instance of etemplate class * * @var etemplate */ var $tmpl; /** * @var Description of the options or value format for each cf_type */ public static $type_option_help = array( 'search' => 'set get_rows, get_title and id_field, or use @path to read options from a file in EGroupware directory', 'select' => 'each value is a line like id[=label], or use @path to read options from a file in EGroupware directory', 'radio' => 'each value is a line like id[=label], or use @path to read options from a file in EGroupware directory', 'button' => 'each value is a line like label=[javascript]', 'password' => 'set length=# for minimum password length, strength=# for password strength', 'serial' => 'you can set an initial value, which gets incremented every time a new serial get generated', 'filemanager' => "use the following options:\nnoVfsSelect=1\nnoUpload=1\nmime=application/pdf or /^image\//i\naccept=pdf,docx\nmax_upload_size=2M", ); /** * Custom fields can also have length and rows set, but these are't used for all types * If not set to true here, the field will be disabled when selecting the type */ public static $type_attribute_flags = array( 'text' => array('cf_len' => true, 'cf_rows' => true), 'float' => array('cf_len' => true), 'passwd'=> array('cf_len' => true, 'cf_rows' => false, 'cf_values' => true), 'label' => array('cf_values' => true), 'select' => array('cf_len' => false, 'cf_rows' => true, 'cf_values' => true), 'date' => array('cf_len' => true, 'cf_rows' => false, 'cf_values' => true), 'date-time' => array('cf_len' => true, 'cf_rows' => false, 'cf_values' => true), 'select-account' => array('cf_len' => false, 'cf_rows' => true), 'htmlarea' => array('cf_len' => true, 'cf_rows' => true), 'button' => array('cf_values' => true), 'radio' => array('cf_values' => true), 'checkbox' => array('cf_values' => true), 'filemanager' => array('cf_values' => true), ); /** * Constructor * * @param string $appname */ function __construct($appname='') { if (($this->appname = $appname)) { $this->fields = Api\Storage\Customfields::get($this->appname,true); $this->content_types = Api\Config::get_content_types($this->appname); } $this->so = new Api\Storage\Base('api','egw_customfields',null,'',true); // Make sure app css & lang get loaded, extending app might cause et2 to miss it Framework::includeCSS('admin','app'); Api\Translation::add_app('admin'); } /** * List custom fields */ public function index($content = array()) { // determine appname $this->appname = $this->appname ?: (!empty($_GET['appname']) ? $_GET['appname'] : (!empty($content['appname']) ? $content['appname'] : false)); if(!$this->appname) die(lang('Error! No appname found')); $this->use_private = !empty($_GET['use_private']) && $_GET['use_private'] !== 'undefined' || !empty($content['use_private']); // Read fields, constructor doesn't always know appname $this->fields = Api\Storage\Customfields::get($this->appname,true, null, null, null); $this->tmpl = new Etemplate(); $this->tmpl->read('admin.customfields'); // do we manage content-types? $test = new Etemplate(); if($test->read($this->appname.'.admin.types')) $this->manage_content_types = true; // Handle incoming - types, options, etc. if($this->manage_content_types) { if(empty($this->content_types)) { $this->content_types = Api\Config::get_content_types($this->appname); } if (empty($this->content_types)) { // if you define your default types of your app with the search_link hook, they are available here, if no types were found $this->content_types = (array)Api\Link::get_registry($this->appname,'default_types'); } // Set this now, we need to know it for updates $this->content_type = $content['content_types']['types'] ?: (array_key_exists(0,$this->content_types) ? $this->content_types[0] : key($this->content_types)); // Common type changes - add, delete if($content['content_types']['delete']) { $this->delete_content_type($content); } elseif($content['content_types']['create']) { if(($new_type = $this->create_content_type($content))) { $content['content_types']['types'] = $this->content_type = $new_type; } unset($content['content_types']['create']); unset($content['content_types']['name']); } // No common type change and type didn't change, try an update to check new type statuses elseif($this->content_type && is_array($content) && $this->content_type == $content['old_content_type']) { $this->update($content); } } // Custom field deleted from nextmatch if($content['nm']['action'] == 'delete') { foreach($this->fields as $name => $data) { if(in_array($data['id'],$content['nm']['selected'])) { $cmd = new admin_cmd_customfield( $this->appname, array('id' => $data['id'],'name' => $name), null, $content['nm']['admin_cmd'] ); $cmd->run(); unset($this->fields[$name]); Framework::refresh_opener('Deleted', 'admin', $data['id'] /* Conflicts with Api\Accounts 'delete'*/); } } } $content['nm']= Api\Cache::getSession('admin', 'customfield-index'); if (!is_array($content['nm'])) { // Initialize nextmatch $content['nm'] = array( 'get_rows' => 'admin.admin_customfields.get_rows', 'no_cat' => 'true', 'no_filter' => 'true', 'no_filter2' => 'true', 'row_id' => 'cf_id', 'order' => 'cf_order',// IO name of the column to sort 'sort' => 'ASC',// IO direction of the sort: 'ASC' or 'DESC' 'actions' => $this->get_actions(), 'dataStorePrefix' => 'customfield' ); } $content['nm']['appname'] = $this->appname; $content['nm']['use_private'] = $this->use_private; // Set up sub-types if($this->manage_content_types) { foreach($this->content_types as $type => $entry) { if(!is_array($entry)) { $this->content_types[$type] = array('name' => $entry); $entry = $this->content_types[$type]; } $this->types2[$type] = $entry['name']; } $sel_options['types'] = $sel_options['cf_type2'] = $this->types2; $content['type_template'] = $this->appname . '.admin.types'; $content['content_types']['appname'] = $this->appname; $content['content_type_options'] = $this->content_types[$this->content_type]['options']; $content['content_type_options']['type'] = $this->types2[$this->content_type]; if ($this->content_types[$this->content_type]['non_deletable']) { $content['content_types']['non_deletable'] = true; } if ($this->content_types['']['no_add']) { $content['content_types']['no_add'] = true; } if ($content['content_types']['non_deletable'] && $content['content_types']['no_add']) { // Hide the whole line if you can't add or delete $content['content_types']['no_edit_types'] = true; } // do NOT allow to delete original contact content-type for addressbook, // as it only creates support problems as users accidentally delete it if ($this->appname == 'addressbook' && $this->content_type == 'n') { $readonlys['content_types']['delete'] = true; } $content['nm']['type2'] = true; } else { // Disable content types $this->tmpl->disableElement('content_types', true); } $sel_options['cf_type'] = Etemplate\Widget\Customfields::getCfTypes(); $sel_options['cf_tab'] = $this->so->query_list('cf_tab', '', ['cf_app' => $this->appname]); $preserve = array( 'appname' => $this->appname, 'use_private' => $this->use_private, 'old_content_type' => $this->content_type ); // Allow extending app a change to change content before display if (!isset($readonlys)) $readonlys = []; static::app_index($content, $sel_options, $readonlys, $preserve); // Set app to admin to make sure actions are correctly loaded into admin $GLOBALS['egw_info']['flags']['currentapp'] = 'admin'; $GLOBALS['egw_info']['flags']['app_header'] = $GLOBALS['egw_info']['apps'][$this->appname]['title'].' - '.lang('Custom fields'); // Some logic to make sure extending class (if there is one) gets called // when etemplate2 comes back instead of parent class $exec = get_class() == get_called_class() || get_called_class() == 'customfields' ? 'admin.admin_customfields.index' : $this->appname . '.' . get_called_class() . '.index'; $this->tmpl->exec($exec,$content,$sel_options,$readonlys,$preserve); } /** * Delete a type over ajax. * * Used when Policy is involved, otherwise things go normally * * @param array $content * @param string $etemplate_exec_id to check against CSRF */ public function ajax_delete_type($content, $etemplate_exec_id) { Api\Etemplate\Request::csrfCheck($etemplate_exec_id, __METHOD__, func_get_args()); // Read fields $this->appname = $content['appname']; $this->fields = Api\Storage\Customfields::get($content['appname'],true); $this->content_types = Api\Config::get_content_types($content['appname']); $this->delete_content_type($content); } /** * Check selectbox values to match regular expression in et2_widget_selectbox.js: _is_multiple_regexp * * If values do not match, comma-separated values are not split by comma! */ const CHECK_MULTISELCT_VALUE = '/^[0-9A-Za-z\/_ -]+$/'; /** * Edit/Create Custom fields with type * * @author Ralf Becker * @param array $content Content from the eTemplate Exec */ function edit($content = null) { $cf_id = isset($_GET['cf_id']) ? (int)$_GET['cf_id'] : (int)$content['cf_id']; // determine appname $this->appname = $this->appname ?: (isset($_GET['appname']) ? $_GET['appname'] : (!empty($content['cf_app']) ? $content['cf_app'] : false)); if(!$this->appname) { if($cf_id && $this->so) { $content = $this->so->read($cf_id); $this->appname = $content['cf_app']; } } if(!$this->appname) { die(lang('Error! No appname found')); } $this->use_private = !isset($_GET['use_private']) || (boolean)$_GET['use_private'] || !empty($content['use_private']); $this->use_readonly = !isset($_GET['use_readonly']) || (boolean)$_GET['use_readonly'] || !empty($content['use_readonly']); // Read fields, constructor doesn't always know appname $this->fields = Api\Storage\Customfields::get($this->appname,true, null, null, null); // Update based on info returned from template if (is_array($content)) { $action = key($content['button'] ?? []); switch($action) { case 'delete': $field = $this->so->read($cf_id); $cmd = new admin_cmd_customfield($this->appname, array('id' => $cf_id,'name' => $field['cf_name'])); $cmd->run(); Framework::refresh_opener('Deleted', 'admin', $cf_id /* Conflicts with Api\Accounts 'delete'*/); Framework::window_close(); break; case 'save': case 'apply': if(!$cf_id && $this->fields[$content['cf_name']]) { Framework::message(lang("Field '%1' already exists !!!",$content['cf_name']),'error'); $content['cf_name'] = ''; break; } if(empty($content['cf_label'])) { $content['cf_label'] = $content['cf_name']; } if (!empty($content['cf_values'])) { $values = array(); if ($content['cf_type'] === 'serial' && !str_starts_with($content['cf_values'], 'last=')) { $content['cf_values'] = 'last=' . $content['cf_values']; } if($content['cf_values'][0] === '@') { $values['@'] = substr($content['cf_values'], $content['cf_values'][1] === '=' ? 2:1); } elseif (isset($GLOBALS['egw_info']['apps'][$content['cf_type']]) && $content['cf_type'] !== 'filemanager') { if (!empty($content['cf_values']) && ($content['cf_values'][0] !== '{' || ($values=json_decode($content['cf_values'])) === null)) { Api\Etemplate::set_validation_error('cf_values', lang('Invalid JSON object!')); } } else { foreach(explode("\n",trim($content['cf_values'])) as $idx => $line) { list($var_raw,$value) = explode('=',trim($line),2); $var = trim($var_raw); if (!preg_match(self::CHECK_MULTISELCT_VALUE, $var) && !($idx == 0 && !$var && $value)) { Api\Etemplate::set_validation_error('cf_values', lang('Invalid value "%1", use only:', $var)."\n". preg_replace('/^.*\[([^]]+)\].*$/', '$1', self::CHECK_MULTISELCT_VALUE)); $action = 'apply'; // do not close the window to show validation error if (!$cf_id) break 2; // only stop storing of new CFs } $values[$var] = trim($value)==='' ? $var : $value; } } if ($content['cf_type'] === 'serial' && !preg_match(Api\Storage\Customfields::SERIAL_PREG, $values['last'])) { Api\Etemplate::set_validation_error('cf_values', lang('Invalid Format, must end in a group of digits e.g. %1 or %2', "'0000'", "'RE2024-0000'")); break; } $content['cf_values'] = $values; } $update_content = array(); foreach($content as $key => $value) { if(substr($key,0,3) == 'cf_') { $update_content[substr($key,3)] = $value; } } $cmd = new admin_cmd_customfield($this->appname, $update_content,null,$content['admin_cmd']); $cmd->run(); if(!$cf_id) { $this->fields = Api\Storage\Customfields::get($this->appname,true); $cf_id = (int)$this->fields[$content['cf_name']]['id']; } Framework::refresh_opener(lang('Entry saved'), 'admin', $cf_id, 'edit'); if ($action != 'save') { break; } //fall through case 'cancel': Framework::window_close(); } } else { $content['use_private'] = !empty($_GET['use_private']) && $_GET['use_private'] !== 'undefined'; } // do we manage content-types? $test = new Etemplate(); if($test->read($this->appname.'.admin.types')) $this->manage_content_types = true; if(is_null($this->tmpl)) { $this->tmpl = new Etemplate(); } $this->tmpl->read('admin.customfield_edit'); Api\Translation::add_app('infolog'); // til we move the translations $GLOBALS['egw_info']['flags']['app_header'] = $GLOBALS['egw_info']['apps'][$this->appname]['title'].' - '.lang('Custom fields'); $sel_options = array(); $readonlys = array(); //echo 'customfields=
'; print_r($this->fields); echo "
\n"; $content['use_private'] = $this->use_private; $content['use_readonly'] = $this->use_readonly; if($cf_id) { $content = array_merge($content, $this->so->read($cf_id)); $this->appname = $content['cf_app']; if($content['cf_private']) { $content['cf_private'] = explode(',',$content['cf_private']); } if($content['cf_readonly']) { $content['cf_readonly'] = explode(',',$content['cf_readonly']); } if (!isset($GLOBALS['egw_info']['apps'][$content['cf_type']]) || $content['cf_type'] === 'filemanager') { $content['cf_values'] = json_decode($content['cf_values'], true); } if ($_GET['action'] ?? null === 'copy') { unset($content['cf_id'], $cf_id); $content['cf_name'] = lang('Copy of').' '.$content['cf_name']; $content['cf_order'] += 5; // behind copied field $readonlys['button[delete]'] = true; } else { if($content['cf_name']) { $readonlys['cf_name'] = true; } if ($content['cf_type'] === 'serial') { $readonlys['cf_values'] = true; // only allow to set start-value, but not change it after } } } else { $readonlys['button[delete]'] = true; $content['cf_order'] = 10*(1+count($this->fields)); } if (is_array($content['cf_values'])) { $values = ''; foreach($content['cf_values'] as $var => $value) { $values .= (!empty($values) ? "\n" : '').$var.'='.$value; } $content['cf_values'] = $values; } // Show sub-type row, and get types if($this->manage_content_types) { $content['cf_type2'] = is_array($content['cf_type2']) ? $content['cf_type2'] : explode(",", $content['cf_type2']); if(empty($this->content_types)) { $this->content_types = Api\Config::get_content_types($this->appname); } if(empty($this->content_types)) { // if you define your default types of your app with the search_link hook, they are available here, if no types were found $this->content_types = (array)Api\Link::get_registry($this->appname, 'default_types'); } foreach($this->content_types as $type => $entry) { $this->types2[$type] = is_array($entry) ? $entry['name'] : $entry; } // Make sure there are no invalid types in the value (from deleted types) $content['cf_type2'] = array_intersect($content['cf_type2'], array_keys($this->types2)); $sel_options['cf_type2'] = $this->types2; } else { $content['no_types'] = true; } // Include type-specific value help foreach(self::$type_option_help as $key => $value) { $content['options'][$key] = lang($value); } $content['statustext'] = $content['options'][$content['cf_type']]; $content['attributes'] = self::$type_attribute_flags; $exec = static::class == 'admin_customfields' ? 'admin.admin_customfields.edit' : $this->appname . '.' . static::class . '.edit'; $this->tmpl->exec($exec, $content, $sel_options, $readonlys, array( 'cf_id' => $cf_id, 'cf_app' => $this->appname, 'cf_name' => $content['cf_name'], 'cf_values' => $content['cf_values'], 'use_private' => $this->use_private, ), 2); } /** * Allow extending apps a change to interfere and add content to support * their custom template. This is called right before etemplate->exec(). */ protected function app_index(&$content, &$sel_options, &$readonlys, &$preserve) { unset($content, $sel_options, $readonlys, $preserve); // not used, as this is a stub // This is just a stub. } /** * Get actions / context menu for index * * Changes here, require to log out, as $content['nm'] get stored in session! * * @return array see nextmatch_widget::egw_actions() */ protected function get_actions() { $edit = $this->appname . '.' . get_class($this) . '.edit'; $actions = array( 'open' => array( // does edit if allowed, otherwise view 'caption' => 'Open', 'default' => true, 'allowOnMultiple' => false, 'url' => 'menuaction='.$edit.'&cf_id=$id&use_private='.$this->use_private, 'popup' => '500x380', 'group' => $group=1, 'disableClass' => 'th', ), 'copy' => array( 'caption' => 'Copy', 'allowOnMultiple' => false, 'url' => 'menuaction='.$edit.'&cf_id=$id&use_private='.$this->use_private.'&action=copy', 'popup' => '500x380', 'group' => $group, ), 'add' => array( 'caption' => 'Add', 'url' => 'menuaction='.$edit.'&appname='.$this->appname.'&use_private='.$this->use_private, 'popup' => '500x380', 'group' => $group, ), 'delete' => array( 'caption' => 'Delete', 'confirm' => 'Delete this entry', 'confirm_multiple' => 'Delete these entries', 'policy_confirmation' => 'Oh yeah', 'group' => ++$group, 'disableClass' => 'rowNoDelete', ), ); return $actions; } function update(&$content) { $this->content_types[$this->content_type]['options'] = $content['content_type_options']; // save changes to repository $this->save_repository(); } /** * deletes custom field from customfield definitions */ function delete_field(&$content) { unset($this->fields[key($content['fields']['delete'])]); // save changes to repository $this->save_repository(); } function delete_content_type(&$content) { $old = array('types' => $this->content_types); unset($this->content_types[$content['content_types']['types']]); unset($this->status[$content['content_types']['types']]); $cmd = new admin_cmd_config($this->appname,array('types' => $this->content_types), $old, $content['admin_cmd']); $cmd->run(); // save changes to repository $this->save_repository(); } /** * create a new custom field */ function create_field(&$content) { $new_name = trim($content['fields'][count((array)$content['fields'])-1]['name']); if (empty($new_name) || isset($this->fields[$new_name])) { $content['error_msg'] .= empty($new_name) ? lang('You have to enter a name, to create a new field!!!') : lang("Field '%1' already exists !!!",$new_name); } else { $this->fields[$new_name] = $content['fields'][count((array)$content['fields'])-1]; if(!$this->fields[$new_name]['label']) $this->fields[$new_name]['label'] = $this->fields[$new_name]['name']; $this->save_repository(); } } /** * Validate and create a new content type * * @param array $content * @return string|boolean New type ID, or false for error */ function create_content_type(&$content) { $new_name = trim($content['content_types']['name']); $new_type = false; if (empty($new_name)) { $this->tmpl->set_validation_error('content_types[name]',lang('you have to enter a name, to create a new type!')); } else { foreach($this->content_types as $type) { if($type['name'] == $new_name) { $this->tmpl->set_validation_error('content_types[name]',lang("type '%1' already exists !!!",$new_name)); return false; } } // search free type character for($i=97;$i<=122;$i++) { if (!$this->content_types[chr($i)] && // skip letter of deleted type for addressbook content-types, as it gives SQL error // content-type are lowercase, Api\Contacts::DELETED_TYPE === 'D', but DB is case-insensitive ($this->appname !== 'addressbook' || chr($i) !== strtolower(Api\Contacts::DELETED_TYPE))) { $new_type = chr($i); break; } } $this->content_types[$new_type] = array('name' => $new_name); $this->save_repository(); } return $new_type; } /** * save changes to repository */ function save_repository() { //echo '

uicustomfields::save_repository() \$this->fields=

'; print_r($this->fields); echo "
\n"; $config = new Api\Config($this->appname); $config->read_repository(); $config->value('types',$this->content_types); $config->save_repository(); } /** * get customfields of using application * * @deprecated use Api\Storage\Customfields::get() direct, no need to instanciate this UI class * @author Cornelius Weiss * @param boolean $all_private_too =false should all the private fields be returned too * @return array with customfields */ function get_customfields($all_private_too=false) { return Api\Storage\Customfields::get($this->appname,$all_private_too); } /** * get_content_types of using application * * @deprecated use Api\Config::get_content_types() direct, no need to instanciate this UI class * @author Cornelius Weiss * @return array with content-types */ function get_content_types() { return Api\Config::get_content_types($this->appname); } /** * Get list of customfields for the nextmatch */ public function get_rows(&$query, &$rows, &$readonlys) { $rows = array(); $query['col_filter']['cf_app'] = $query['appname']; $total = $this->so->get_rows($query, $rows, $readonlys); unset($query['col_filter']['cf_app']); foreach($rows as &$row) { $row['cf_values'] = json_decode($row['cf_values'], true) ?? $row['cf_values']; if (is_array($row['cf_values'])) { $values = ''; foreach($row['cf_values'] as $var => $value) { $values .= (!empty($values) ? "\n" : '').$var.'='.$value; } $row['cf_values'] = $values; } } return $total; } }